File size: 78,544 Bytes
065fee7 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 |
.. _aiohttp-client-reference:
Client Reference
================
.. currentmodule:: aiohttp
Client Session
--------------
Client session is the recommended interface for making HTTP requests.
Session encapsulates a *connection pool* (*connector* instance) and
supports keepalives by default. Unless you are connecting to a large,
unknown number of different servers over the lifetime of your
application, it is suggested you use a single session for the
lifetime of your application to benefit from connection pooling.
Usage example::
import aiohttp
import asyncio
async def fetch(client):
async with client.get('http://python.org') as resp:
assert resp.status == 200
return await resp.text()
async def main():
async with aiohttp.ClientSession() as client:
html = await fetch(client)
print(html)
asyncio.run(main())
The client session supports the context manager protocol for self closing.
.. class:: ClientSession(base_url=None, *, \
connector=None, cookies=None, \
headers=None, skip_auto_headers=None, \
auth=None, json_serialize=json.dumps, \
version=aiohttp.HttpVersion11, \
cookie_jar=None, read_timeout=None, \
conn_timeout=None, \
timeout=sentinel, \
raise_for_status=False, \
connector_owner=True, \
auto_decompress=True, \
read_bufsize=2**16, \
requote_redirect_url=True, \
trust_env=False, \
trace_configs=None, \
fallback_charset_resolver=lambda r, b: "utf-8")
The class for creating client sessions and making requests.
:param base_url: Base part of the URL (optional)
If set, it allows to skip the base part (https://docs.aiohttp.org) in
request calls. It must not include a path (as in
https://docs.aiohttp.org/en/stable).
.. versionadded:: 3.8
:param aiohttp.BaseConnector connector: BaseConnector
sub-class instance to support connection pooling.
:param loop: :ref:`event loop<asyncio-event-loop>` used for
processing HTTP requests.
If *loop* is ``None`` the constructor
borrows it from *connector* if specified.
:func:`asyncio.get_event_loop` is used for getting default event
loop otherwise.
.. deprecated:: 2.0
:param dict cookies: Cookies to send with the request (optional)
:param headers: HTTP Headers to send with every request (optional).
May be either *iterable of key-value pairs* or
:class:`~collections.abc.Mapping`
(e.g. :class:`dict`,
:class:`~multidict.CIMultiDict`).
:param skip_auto_headers: set of headers for which autogeneration
should be skipped.
*aiohttp* autogenerates headers like ``User-Agent`` or
``Content-Type`` if these headers are not explicitly
passed. Using ``skip_auto_headers`` parameter allows to skip
that generation. Note that ``Content-Length`` autogeneration can't
be skipped.
Iterable of :class:`str` or :class:`~multidict.istr` (optional)
:param aiohttp.BasicAuth auth: an object that represents HTTP Basic
Authorization (optional)
:param version: supported HTTP version, ``HTTP 1.1`` by default.
:param cookie_jar: Cookie Jar, :class:`~aiohttp.abc.AbstractCookieJar` instance.
By default every session instance has own private cookie jar for
automatic cookies processing but user may redefine this behavior
by providing own jar implementation.
One example is not processing cookies at all when working in
proxy mode.
If no cookie processing is needed, a
:class:`aiohttp.DummyCookieJar` instance can be
provided.
:param collections.abc.Callable json_serialize: Json *serializer* callable.
By default :func:`json.dumps` function.
:param bool raise_for_status:
Automatically call :meth:`ClientResponse.raise_for_status()` for
each response, ``False`` by default.
This parameter can be overridden when you making a request, e.g.::
client_session = aiohttp.ClientSession(raise_for_status=True)
resp = await client_session.get(url, raise_for_status=False)
async with resp:
assert resp.status == 200
Set the parameter to ``True`` if you need ``raise_for_status``
for most of cases but override ``raise_for_status`` for those
requests where you need to handle responses with status 400 or
higher.
You can also provide a coroutine which takes the response as an
argument and can raise an exception based on custom logic, e.g.::
async def custom_check(response):
if response.status not in {201, 202}:
raise RuntimeError('expected either 201 or 202')
text = await response.text()
if 'apple pie' not in text:
raise RuntimeError('I wanted to see "apple pie" in response')
client_session = aiohttp.ClientSession(raise_for_status=custom_check)
...
As with boolean values, you're free to set this on the session and/or
overwrite it on a per-request basis.
:param timeout: a :class:`ClientTimeout` settings structure, 300 seconds (5min)
total timeout by default.
.. versionadded:: 3.3
:param float read_timeout: Request operations timeout. ``read_timeout`` is
cumulative for all request operations (request, redirects, responses,
data consuming). By default, the read timeout is 5*60 seconds.
Use ``None`` or ``0`` to disable timeout checks.
.. deprecated:: 3.3
Use ``timeout`` parameter instead.
:param float conn_timeout: timeout for connection establishing
(optional). Values ``0`` or ``None`` mean no timeout.
.. deprecated:: 3.3
Use ``timeout`` parameter instead.
:param bool connector_owner:
Close connector instance on session closing.
Setting the parameter to ``False`` allows to share
connection pool between sessions without sharing session state:
cookies etc.
:param bool auto_decompress: Automatically decompress response body (``True`` by default).
.. versionadded:: 2.3
:param int read_bufsize: Size of the read buffer (:attr:`ClientResponse.content`).
64 KiB by default.
.. versionadded:: 3.7
:param bool trust_env: Trust environment settings for proxy configuration if the parameter
is ``True`` (``False`` by default). See :ref:`aiohttp-client-proxy-support` for
more information.
Get proxy credentials from ``~/.netrc`` file if present.
Get HTTP Basic Auth credentials from :file:`~/.netrc` file if present.
If :envvar:`NETRC` environment variable is set, read from file specified
there rather than from :file:`~/.netrc`.
.. seealso::
``.netrc`` documentation: https://www.gnu.org/software/inetutils/manual/html_node/The-_002enetrc-file.html
.. versionadded:: 2.3
.. versionchanged:: 3.0
Added support for ``~/.netrc`` file.
.. versionchanged:: 3.9
Added support for reading HTTP Basic Auth credentials from :file:`~/.netrc` file.
:param bool requote_redirect_url: Apply *URL requoting* for redirection URLs if
automatic redirection is enabled (``True`` by
default).
.. versionadded:: 3.5
:param trace_configs: A list of :class:`TraceConfig` instances used for client
tracing. ``None`` (default) is used for request tracing
disabling. See :ref:`aiohttp-client-tracing-reference` for
more information.
:param Callable[[ClientResponse,bytes],str] fallback_charset_resolver:
A :term:`callable` that accepts a :class:`ClientResponse` and the
:class:`bytes` contents, and returns a :class:`str` which will be used as
the encoding parameter to :meth:`bytes.decode()`.
This function will be called when the charset is not known (e.g. not specified in the
Content-Type header). The default function simply defaults to ``utf-8``.
.. versionadded:: 3.8.6
.. attribute:: closed
``True`` if the session has been closed, ``False`` otherwise.
A read-only property.
.. attribute:: connector
:class:`aiohttp.BaseConnector` derived instance used
for the session.
A read-only property.
.. attribute:: cookie_jar
The session cookies, :class:`~aiohttp.abc.AbstractCookieJar` instance.
Gives access to cookie jar's content and modifiers.
A read-only property.
.. attribute:: requote_redirect_url
aiohttp re quote's redirect urls by default, but some servers
require exact url from location header. To disable *re-quote* system
set :attr:`requote_redirect_url` attribute to ``False``.
.. versionadded:: 2.1
.. note:: This parameter affects all subsequent requests.
.. deprecated:: 3.5
The attribute modification is deprecated.
.. attribute:: loop
A loop instance used for session creation.
A read-only property.
.. deprecated:: 3.5
.. attribute:: timeout
Default client timeouts, :class:`ClientTimeout` instance. The value can
be tuned by passing *timeout* parameter to :class:`ClientSession`
constructor.
.. versionadded:: 3.7
.. attribute:: headers
HTTP Headers that sent with every request
May be either *iterable of key-value pairs* or
:class:`~collections.abc.Mapping`
(e.g. :class:`dict`,
:class:`~multidict.CIMultiDict`).
.. versionadded:: 3.7
.. attribute:: skip_auto_headers
Set of headers for which autogeneration skipped.
:class:`frozenset` of :class:`str` or :class:`~multidict.istr` (optional)
.. versionadded:: 3.7
.. attribute:: auth
An object that represents HTTP Basic Authorization.
:class:`~aiohttp.BasicAuth` (optional)
.. versionadded:: 3.7
.. attribute:: json_serialize
Json serializer callable.
By default :func:`json.dumps` function.
.. versionadded:: 3.7
.. attribute:: connector_owner
Should connector be closed on session closing
:class:`bool` (optional)
.. versionadded:: 3.7
.. attribute:: raise_for_status
Should :meth:`ClientResponse.raise_for_status()` be called for each response
Either :class:`bool` or :class:`collections.abc.Callable`
.. versionadded:: 3.7
.. attribute:: auto_decompress
Should the body response be automatically decompressed
:class:`bool` default is ``True``
.. versionadded:: 3.7
.. attribute:: trust_env
Trust environment settings for proxy configuration
or ~/.netrc file if present. See :ref:`aiohttp-client-proxy-support` for
more information.
:class:`bool` default is ``False``
.. versionadded:: 3.7
.. attribute:: trace_config
A list of :class:`TraceConfig` instances used for client
tracing. ``None`` (default) is used for request tracing
disabling. See :ref:`aiohttp-client-tracing-reference` for more information.
.. versionadded:: 3.7
.. method:: request(method, url, *, params=None, data=None, json=None,\
cookies=None, headers=None, skip_auto_headers=None, \
auth=None, allow_redirects=True,\
max_redirects=10,\
compress=None, chunked=None, expect100=False, raise_for_status=None,\
read_until_eof=True, \
read_bufsize=None, \
proxy=None, proxy_auth=None,\
timeout=sentinel, ssl=True, \
verify_ssl=None, fingerprint=None, \
ssl_context=None, proxy_headers=None, \
server_hostname=None, auto_decompress=None)
:async:
:noindexentry:
Performs an asynchronous HTTP request. Returns a response object that
should be used as an async context manager.
:param str method: HTTP method
:param url: Request URL, :class:`~yarl.URL` or :class:`str` that will
be encoded with :class:`~yarl.URL` (see :class:`~yarl.URL`
to skip encoding).
:param params: Mapping, iterable of tuple of *key*/*value* pairs or
string to be sent as parameters in the query
string of the new request. Ignored for subsequent
redirected requests (optional)
Allowed values are:
- :class:`collections.abc.Mapping` e.g. :class:`dict`,
:class:`multidict.MultiDict` or
:class:`multidict.MultiDictProxy`
- :class:`collections.abc.Iterable` e.g. :class:`tuple` or
:class:`list`
- :class:`str` with preferably url-encoded content
(**Warning:** content will not be encoded by *aiohttp*)
:param data: The data to send in the body of the request. This can be a
:class:`FormData` object or anything that can be passed into
:class:`FormData`, e.g. a dictionary, bytes, or file-like object.
(optional)
:param json: Any json compatible python object
(optional). *json* and *data* parameters could not
be used at the same time.
:param dict cookies: HTTP Cookies to send with
the request (optional)
Global session cookies and the explicitly set cookies will be merged
when sending the request.
.. versionadded:: 3.5
:param dict headers: HTTP Headers to send with
the request (optional)
:param skip_auto_headers: set of headers for which autogeneration
should be skipped.
*aiohttp* autogenerates headers like ``User-Agent`` or
``Content-Type`` if these headers are not explicitly
passed. Using ``skip_auto_headers`` parameter allows to skip
that generation.
Iterable of :class:`str` or :class:`~multidict.istr`
(optional)
:param aiohttp.BasicAuth auth: an object that represents HTTP
Basic Authorization (optional)
:param bool allow_redirects: If set to ``False``, do not follow redirects.
``True`` by default (optional).
:param int max_redirects: Maximum number of redirects to follow.
``10`` by default.
:param bool compress: Set to ``True`` if request has to be compressed
with deflate encoding. If `compress` can not be combined
with a *Content-Encoding* and *Content-Length* headers.
``None`` by default (optional).
:param int chunked: Enable chunked transfer encoding.
It is up to the developer
to decide how to chunk data streams. If chunking is enabled, aiohttp
encodes the provided chunks in the "Transfer-encoding: chunked" format.
If *chunked* is set, then the *Transfer-encoding* and *content-length*
headers are disallowed. ``None`` by default (optional).
:param bool expect100: Expect 100-continue response from server.
``False`` by default (optional).
:param bool raise_for_status: Automatically call :meth:`ClientResponse.raise_for_status()` for
response if set to ``True``.
If set to ``None`` value from ``ClientSession`` will be used.
``None`` by default (optional).
.. versionadded:: 3.4
:param bool read_until_eof: Read response until EOF if response
does not have Content-Length header.
``True`` by default (optional).
:param int read_bufsize: Size of the read buffer (:attr:`ClientResponse.content`).
``None`` by default,
it means that the session global value is used.
.. versionadded:: 3.7
:param proxy: Proxy URL, :class:`str` or :class:`~yarl.URL` (optional)
:param aiohttp.BasicAuth proxy_auth: an object that represents proxy HTTP
Basic Authorization (optional)
:param int timeout: override the session's timeout.
.. versionchanged:: 3.3
The parameter is :class:`ClientTimeout` instance,
:class:`float` is still supported for sake of backward
compatibility.
If :class:`float` is passed it is a *total* timeout (in seconds).
:param ssl: SSL validation mode. ``True`` for default SSL check
(:func:`ssl.create_default_context` is used),
``False`` for skip SSL certificate validation,
:class:`aiohttp.Fingerprint` for fingerprint
validation, :class:`ssl.SSLContext` for custom SSL
certificate validation.
Supersedes *verify_ssl*, *ssl_context* and
*fingerprint* parameters.
.. versionadded:: 3.0
:param bool verify_ssl: Perform SSL certificate validation for
*HTTPS* requests (enabled by default). May be disabled to
skip validation for sites with invalid certificates.
.. versionadded:: 2.3
.. deprecated:: 3.0
Use ``ssl=False``
:param bytes fingerprint: Pass the SHA256 digest of the expected
certificate in DER format to verify that the certificate the
server presents matches. Useful for `certificate pinning
<https://en.wikipedia.org/wiki/HTTP_Public_Key_Pinning>`_.
Warning: use of MD5 or SHA1 digests is insecure and removed.
.. versionadded:: 2.3
.. deprecated:: 3.0
Use ``ssl=aiohttp.Fingerprint(digest)``
:param str server_hostname: Sets or overrides the host name that the
target server’s certificate will be matched against.
See :py:meth:`asyncio.loop.create_connection` for more information.
.. versionadded:: 3.9
:param ssl.SSLContext ssl_context: ssl context used for processing
*HTTPS* requests (optional).
*ssl_context* may be used for configuring certification
authority channel, supported SSL options etc.
.. versionadded:: 2.3
.. deprecated:: 3.0
Use ``ssl=ssl_context``
:param collections.abc.Mapping proxy_headers: HTTP headers to send to the proxy if the
parameter proxy has been provided.
.. versionadded:: 2.3
:param trace_request_ctx: Object used to give as a kw param for each new
:class:`TraceConfig` object instantiated,
used to give information to the
tracers that is only available at request time.
.. versionadded:: 3.0
:param bool auto_decompress: Automatically decompress response body.
Overrides :attr:`ClientSession.auto_decompress`.
May be used to enable/disable auto decompression on a per-request basis.
:return ClientResponse: a :class:`client response <ClientResponse>`
object.
.. method:: get(url, *, allow_redirects=True, **kwargs)
:async:
Perform a ``GET`` request. Returns an async context manager.
In order to modify inner
:meth:`request<aiohttp.ClientSession.request>`
parameters, provide `kwargs`.
:param url: Request URL, :class:`str` or :class:`~yarl.URL`
:param bool allow_redirects: If set to ``False``, do not follow redirects.
``True`` by default (optional).
:return ClientResponse: a :class:`client response
<ClientResponse>` object.
.. method:: post(url, *, data=None, **kwargs)
:async:
Perform a ``POST`` request. Returns an async context manager.
In order to modify inner
:meth:`request<aiohttp.ClientSession.request>`
parameters, provide `kwargs`.
:param url: Request URL, :class:`str` or :class:`~yarl.URL`
:param data: Data to send in the body of the request; see
:meth:`request<aiohttp.ClientSession.request>`
for details (optional)
:return ClientResponse: a :class:`client response
<ClientResponse>` object.
.. method:: put(url, *, data=None, **kwargs)
:async:
Perform a ``PUT`` request. Returns an async context manager.
In order to modify inner
:meth:`request<aiohttp.ClientSession.request>`
parameters, provide `kwargs`.
:param url: Request URL, :class:`str` or :class:`~yarl.URL`
:param data: Data to send in the body of the request; see
:meth:`request<aiohttp.ClientSession.request>`
for details (optional)
:return ClientResponse: a :class:`client response
<ClientResponse>` object.
.. method:: delete(url, **kwargs)
:async:
Perform a ``DELETE`` request. Returns an async context manager.
In order to modify inner
:meth:`request<aiohttp.ClientSession.request>`
parameters, provide `kwargs`.
:param url: Request URL, :class:`str` or :class:`~yarl.URL`
:return ClientResponse: a :class:`client response
<ClientResponse>` object.
.. method:: head(url, *, allow_redirects=False, **kwargs)
:async:
Perform a ``HEAD`` request. Returns an async context manager.
In order to modify inner
:meth:`request<aiohttp.ClientSession.request>`
parameters, provide `kwargs`.
:param url: Request URL, :class:`str` or :class:`~yarl.URL`
:param bool allow_redirects: If set to ``False``, do not follow redirects.
``False`` by default (optional).
:return ClientResponse: a :class:`client response
<ClientResponse>` object.
.. method:: options(url, *, allow_redirects=True, **kwargs)
:async:
Perform an ``OPTIONS`` request. Returns an async context manager.
In order to modify inner
:meth:`request<aiohttp.ClientSession.request>`
parameters, provide `kwargs`.
:param url: Request URL, :class:`str` or :class:`~yarl.URL`
:param bool allow_redirects: If set to ``False``, do not follow redirects.
``True`` by default (optional).
:return ClientResponse: a :class:`client response
<ClientResponse>` object.
.. method:: patch(url, *, data=None, **kwargs)
:async:
Perform a ``PATCH`` request. Returns an async context manager.
In order to modify inner
:meth:`request<aiohttp.ClientSession.request>`
parameters, provide `kwargs`.
:param url: Request URL, :class:`str` or :class:`~yarl.URL`
:param data: Data to send in the body of the request; see
:meth:`request<aiohttp.ClientSession.request>`
for details (optional)
:return ClientResponse: a :class:`client response
<ClientResponse>` object.
.. method:: ws_connect(url, *, method='GET', \
protocols=(), timeout=10.0,\
receive_timeout=None,\
auth=None,\
autoclose=True,\
autoping=True,\
heartbeat=None,\
origin=None, \
params=None, \
headers=None, \
proxy=None, proxy_auth=None, ssl=True, \
verify_ssl=None, fingerprint=None, \
ssl_context=None, proxy_headers=None, \
compress=0, max_msg_size=4194304)
:async:
Create a websocket connection. Returns a
:class:`ClientWebSocketResponse` async context manager object.
:param url: Websocket server url, :class:`~yarl.URL` or :class:`str` that
will be encoded with :class:`~yarl.URL` (see :class:`~yarl.URL`
to skip encoding).
:param tuple protocols: Websocket protocols
:param float timeout: Timeout for websocket to close. ``10`` seconds
by default
:param float receive_timeout: Timeout for websocket to receive
complete message. ``None`` (unlimited)
seconds by default
:param aiohttp.BasicAuth auth: an object that represents HTTP
Basic Authorization (optional)
:param bool autoclose: Automatically close websocket connection on close
message from server. If *autoclose* is False
then close procedure has to be handled manually.
``True`` by default
:param bool autoping: automatically send *pong* on *ping*
message from server. ``True`` by default
:param float heartbeat: Send *ping* message every *heartbeat*
seconds and wait *pong* response, if
*pong* response is not received then
close connection. The timer is reset on any data
reception.(optional)
:param str origin: Origin header to send to server(optional)
:param params: Mapping, iterable of tuple of *key*/*value* pairs or
string to be sent as parameters in the query
string of the new request. Ignored for subsequent
redirected requests (optional)
Allowed values are:
- :class:`collections.abc.Mapping` e.g. :class:`dict`,
:class:`multidict.MultiDict` or
:class:`multidict.MultiDictProxy`
- :class:`collections.abc.Iterable` e.g. :class:`tuple` or
:class:`list`
- :class:`str` with preferably url-encoded content
(**Warning:** content will not be encoded by *aiohttp*)
:param dict headers: HTTP Headers to send with
the request (optional)
:param str proxy: Proxy URL, :class:`str` or :class:`~yarl.URL` (optional)
:param aiohttp.BasicAuth proxy_auth: an object that represents proxy HTTP
Basic Authorization (optional)
:param ssl: SSL validation mode. ``True`` for default SSL check
(:func:`ssl.create_default_context` is used),
``False`` for skip SSL certificate validation,
:class:`aiohttp.Fingerprint` for fingerprint
validation, :class:`ssl.SSLContext` for custom SSL
certificate validation.
Supersedes *verify_ssl*, *ssl_context* and
*fingerprint* parameters.
.. versionadded:: 3.0
:param bool verify_ssl: Perform SSL certificate validation for
*HTTPS* requests (enabled by default). May be disabled to
skip validation for sites with invalid certificates.
.. versionadded:: 2.3
.. deprecated:: 3.0
Use ``ssl=False``
:param bytes fingerprint: Pass the SHA256 digest of the expected
certificate in DER format to verify that the certificate the
server presents matches. Useful for `certificate pinning
<https://en.wikipedia.org/wiki/HTTP_Public_Key_Pinning>`_.
Note: use of MD5 or SHA1 digests is insecure and deprecated.
.. versionadded:: 2.3
.. deprecated:: 3.0
Use ``ssl=aiohttp.Fingerprint(digest)``
:param ssl.SSLContext ssl_context: ssl context used for processing
*HTTPS* requests (optional).
*ssl_context* may be used for configuring certification
authority channel, supported SSL options etc.
.. versionadded:: 2.3
.. deprecated:: 3.0
Use ``ssl=ssl_context``
:param dict proxy_headers: HTTP headers to send to the proxy if the
parameter proxy has been provided.
.. versionadded:: 2.3
:param int compress: Enable Per-Message Compress Extension support.
0 for disable, 9 to 15 for window bit support.
Default value is 0.
.. versionadded:: 2.3
:param int max_msg_size: maximum size of read websocket message,
4 MB by default. To disable the size
limit use ``0``.
.. versionadded:: 3.3
:param str method: HTTP method to establish WebSocket connection,
``'GET'`` by default.
.. versionadded:: 3.5
.. method:: close()
:async:
Close underlying connector.
Release all acquired resources.
.. method:: detach()
Detach connector from session without closing the former.
Session is switched to closed state anyway.
Basic API
---------
While we encourage :class:`ClientSession` usage we also provide simple
coroutines for making HTTP requests.
Basic API is good for performing simple HTTP requests without
keepaliving, cookies and complex connection stuff like properly configured SSL
certification chaining.
.. function:: request(method, url, *, params=None, data=None, \
json=None,\
headers=None, cookies=None, auth=None, \
allow_redirects=True, max_redirects=10, \
encoding='utf-8', \
version=HttpVersion(major=1, minor=1), \
compress=None, chunked=None, expect100=False, raise_for_status=False, \
read_bufsize=None, \
connector=None, loop=None,\
read_until_eof=True, timeout=sentinel)
:async:
Asynchronous context manager for performing an asynchronous HTTP
request. Returns a :class:`ClientResponse` response object. Use as
an async context manager.
:param str method: HTTP method
:param url: Request URL, :class:`~yarl.URL` or :class:`str` that will
be encoded with :class:`~yarl.URL` (see :class:`~yarl.URL`
to skip encoding).
:param dict params: Parameters to be sent in the query
string of the new request (optional)
:param data: The data to send in the body of the request. This can be a
:class:`FormData` object or anything that can be passed into
:class:`FormData`, e.g. a dictionary, bytes, or file-like object.
(optional)
:param json: Any json compatible python object (optional). *json* and *data*
parameters could not be used at the same time.
:param dict headers: HTTP Headers to send with the request (optional)
:param dict cookies: Cookies to send with the request (optional)
:param aiohttp.BasicAuth auth: an object that represents HTTP Basic
Authorization (optional)
:param bool allow_redirects: If set to ``False``, do not follow redirects.
``True`` by default (optional).
:param aiohttp.protocol.HttpVersion version: Request HTTP version (optional)
:param bool compress: Set to ``True`` if request has to be compressed
with deflate encoding.
``False`` instructs aiohttp to not compress data.
``None`` by default (optional).
:param int chunked: Enables chunked transfer encoding.
``None`` by default (optional).
:param bool expect100: Expect 100-continue response from server.
``False`` by default (optional).
:param bool raise_for_status: Automatically call
:meth:`ClientResponse.raise_for_status()`
for response if set to ``True``. If
set to ``None`` value from
``ClientSession`` will be used.
``None`` by default (optional).
.. versionadded:: 3.4
:param aiohttp.BaseConnector connector: BaseConnector sub-class
instance to support connection pooling.
:param bool read_until_eof: Read response until EOF if response
does not have Content-Length header.
``True`` by default (optional).
:param int read_bufsize: Size of the read buffer (:attr:`ClientResponse.content`).
``None`` by default,
it means that the session global value is used.
.. versionadded:: 3.7
:param timeout: a :class:`ClientTimeout` settings structure, 300 seconds (5min)
total timeout by default.
:param loop: :ref:`event loop<asyncio-event-loop>`
used for processing HTTP requests.
If param is ``None``, :func:`asyncio.get_event_loop`
is used for getting default event loop.
.. deprecated:: 2.0
:return ClientResponse: a :class:`client response <ClientResponse>` object.
Usage::
import aiohttp
async def fetch():
async with aiohttp.request('GET',
'http://python.org/') as resp:
assert resp.status == 200
print(await resp.text())
.. _aiohttp-client-reference-connectors:
Connectors
----------
Connectors are transports for aiohttp client API.
There are standard connectors:
1. :class:`TCPConnector` for regular *TCP sockets* (both *HTTP* and
*HTTPS* schemes supported).
2. :class:`UnixConnector` for connecting via UNIX socket (it's used mostly for
testing purposes).
All connector classes should be derived from :class:`BaseConnector`.
By default all *connectors* support *keep-alive connections* (behavior
is controlled by *force_close* constructor's parameter).
.. class:: BaseConnector(*, keepalive_timeout=15, \
force_close=False, limit=100, limit_per_host=0, \
enable_cleanup_closed=False, loop=None)
Base class for all connectors.
:param float keepalive_timeout: timeout for connection reusing
after releasing (optional). Values
``0``. For disabling *keep-alive*
feature use ``force_close=True``
flag.
:param int limit: total number simultaneous connections. If *limit* is
``None`` the connector has no limit (default: 100).
:param int limit_per_host: limit simultaneous connections to the same
endpoint. Endpoints are the same if they are
have equal ``(host, port, is_ssl)`` triple.
If *limit* is ``0`` the connector has no limit (default: 0).
:param bool force_close: close underlying sockets after
connection releasing (optional).
:param bool enable_cleanup_closed: some SSL servers do not properly complete
SSL shutdown process, in that case asyncio leaks ssl connections.
If this parameter is set to True, aiohttp additionally aborts underlining
transport after 2 seconds. It is off by default.
:param loop: :ref:`event loop<asyncio-event-loop>`
used for handling connections.
If param is ``None``, :func:`asyncio.get_event_loop`
is used for getting default event loop.
.. deprecated:: 2.0
.. attribute:: closed
Read-only property, ``True`` if connector is closed.
.. attribute:: force_close
Read-only property, ``True`` if connector should ultimately
close connections on releasing.
.. attribute:: limit
The total number for simultaneous connections.
If limit is 0 the connector has no limit. The default limit size is 100.
.. attribute:: limit_per_host
The limit for simultaneous connections to the same
endpoint.
Endpoints are the same if they are have equal ``(host, port,
is_ssl)`` triple.
If *limit_per_host* is ``None`` the connector has no limit per host.
Read-only property.
.. method:: close()
:async:
Close all opened connections.
.. method:: connect(request)
:async:
Get a free connection from pool or create new one if connection
is absent in the pool.
The call may be paused if :attr:`limit` is exhausted until used
connections returns to pool.
:param aiohttp.ClientRequest request: request object
which is connection
initiator.
:return: :class:`Connection` object.
.. method:: _create_connection(req)
:async:
Abstract method for actual connection establishing, should be
overridden in subclasses.
.. class:: TCPConnector(*, ssl=True, verify_ssl=True, fingerprint=None, \
use_dns_cache=True, ttl_dns_cache=10, \
family=0, ssl_context=None, local_addr=None, \
resolver=None, keepalive_timeout=sentinel, \
force_close=False, limit=100, limit_per_host=0, \
enable_cleanup_closed=False, timeout_ceil_threshold=5, \
happy_eyeballs_delay=0.25, interleave=None, loop=None)
Connector for working with *HTTP* and *HTTPS* via *TCP* sockets.
The most common transport. When you don't know what connector type
to use, use a :class:`TCPConnector` instance.
:class:`TCPConnector` inherits from :class:`BaseConnector`.
Constructor accepts all parameters suitable for
:class:`BaseConnector` plus several TCP-specific ones:
:param ssl: SSL validation mode. ``True`` for default SSL check
(:func:`ssl.create_default_context` is used),
``False`` for skip SSL certificate validation,
:class:`aiohttp.Fingerprint` for fingerprint
validation, :class:`ssl.SSLContext` for custom SSL
certificate validation.
Supersedes *verify_ssl*, *ssl_context* and
*fingerprint* parameters.
.. versionadded:: 3.0
:param bool verify_ssl: perform SSL certificate validation for
*HTTPS* requests (enabled by default). May be disabled to
skip validation for sites with invalid certificates.
.. deprecated:: 2.3
Pass *verify_ssl* to ``ClientSession.get()`` etc.
:param bytes fingerprint: pass the SHA256 digest of the expected
certificate in DER format to verify that the certificate the
server presents matches. Useful for `certificate pinning
<https://en.wikipedia.org/wiki/HTTP_Public_Key_Pinning>`_.
Note: use of MD5 or SHA1 digests is insecure and deprecated.
.. deprecated:: 2.3
Pass *verify_ssl* to ``ClientSession.get()`` etc.
:param bool use_dns_cache: use internal cache for DNS lookups, ``True``
by default.
Enabling an option *may* speedup connection
establishing a bit but may introduce some
*side effects* also.
:param int ttl_dns_cache: expire after some seconds the DNS entries, ``None``
means cached forever. By default 10 seconds (optional).
In some environments the IP addresses related to a specific HOST can
change after a specific time. Use this option to keep the DNS cache
updated refreshing each entry after N seconds.
:param int limit: total number simultaneous connections. If *limit* is
``None`` the connector has no limit (default: 100).
:param int limit_per_host: limit simultaneous connections to the same
endpoint. Endpoints are the same if they are
have equal ``(host, port, is_ssl)`` triple.
If *limit* is ``0`` the connector has no limit (default: 0).
:param aiohttp.abc.AbstractResolver resolver: custom resolver
instance to use. ``aiohttp.DefaultResolver`` by
default (asynchronous if ``aiodns>=1.1`` is installed).
Custom resolvers allow to resolve hostnames differently than the
way the host is configured.
The resolver is ``aiohttp.ThreadedResolver`` by default,
asynchronous version is pretty robust but might fail in
very rare cases.
:param int family: TCP socket family, both IPv4 and IPv6 by default.
For *IPv4* only use :data:`socket.AF_INET`,
for *IPv6* only -- :data:`socket.AF_INET6`.
*family* is ``0`` by default, that means both
IPv4 and IPv6 are accepted. To specify only
concrete version please pass
:data:`socket.AF_INET` or
:data:`socket.AF_INET6` explicitly.
:param ssl.SSLContext ssl_context: SSL context used for processing
*HTTPS* requests (optional).
*ssl_context* may be used for configuring certification
authority channel, supported SSL options etc.
:param tuple local_addr: tuple of ``(local_host, local_port)`` used to bind
socket locally if specified.
:param bool force_close: close underlying sockets after
connection releasing (optional).
:param bool enable_cleanup_closed: Some ssl servers do not properly complete
SSL shutdown process, in that case asyncio leaks SSL connections.
If this parameter is set to True, aiohttp additionally aborts underlining
transport after 2 seconds. It is off by default.
:param float happy_eyeballs_delay: The amount of time in seconds to wait for a
connection attempt to complete, before starting the next attempt in parallel.
This is the “Connection Attempt Delay” as defined in RFC 8305. To disable
Happy Eyeballs, set this to ``None``. The default value recommended by the
RFC is 0.25 (250 milliseconds).
.. versionadded:: 3.10
:param int interleave: controls address reordering when a host name resolves
to multiple IP addresses. If ``0`` or unspecified, no reordering is done, and
addresses are tried in the order returned by the resolver. If a positive
integer is specified, the addresses are interleaved by address family, and
the given integer is interpreted as “First Address Family Count” as defined
in RFC 8305. The default is ``0`` if happy_eyeballs_delay is not specified, and
``1`` if it is.
.. versionadded:: 3.10
.. attribute:: family
*TCP* socket family e.g. :data:`socket.AF_INET` or
:data:`socket.AF_INET6`
Read-only property.
.. attribute:: dns_cache
Use quick lookup in internal *DNS* cache for host names if ``True``.
Read-only :class:`bool` property.
.. attribute:: cached_hosts
The cache of resolved hosts if :attr:`dns_cache` is enabled.
Read-only :class:`types.MappingProxyType` property.
.. method:: clear_dns_cache(self, host=None, port=None)
Clear internal *DNS* cache.
Remove specific entry if both *host* and *port* are specified,
clear all cache otherwise.
.. class:: UnixConnector(path, *, conn_timeout=None, \
keepalive_timeout=30, limit=100, \
force_close=False, loop=None)
Unix socket connector.
Use :class:`UnixConnector` for sending *HTTP/HTTPS* requests
through *UNIX Sockets* as underlying transport.
UNIX sockets are handy for writing tests and making very fast
connections between processes on the same host.
:class:`UnixConnector` is inherited from :class:`BaseConnector`.
Usage::
conn = UnixConnector(path='/path/to/socket')
session = ClientSession(connector=conn)
async with session.get('http://python.org') as resp:
...
Constructor accepts all parameters suitable for
:class:`BaseConnector` plus UNIX-specific one:
:param str path: Unix socket path
.. attribute:: path
Path to *UNIX socket*, read-only :class:`str` property.
.. class:: Connection
Encapsulates single connection in connector object.
End user should never create :class:`Connection` instances manually
but get it by :meth:`BaseConnector.connect` coroutine.
.. attribute:: closed
:class:`bool` read-only property, ``True`` if connection was
closed, released or detached.
.. attribute:: loop
Event loop used for connection
.. deprecated:: 3.5
.. attribute:: transport
Connection transport
.. method:: close()
Close connection with forcibly closing underlying socket.
.. method:: release()
Release connection back to connector.
Underlying socket is not closed, the connection may be reused
later if timeout (30 seconds by default) for connection was not
expired.
Response object
---------------
.. class:: ClientResponse
Client response returned by :meth:`aiohttp.ClientSession.request` and family.
User never creates the instance of ClientResponse class but gets it
from API calls.
:class:`ClientResponse` supports async context manager protocol, e.g.::
resp = await client_session.get(url)
async with resp:
assert resp.status == 200
After exiting from ``async with`` block response object will be
*released* (see :meth:`release` method).
.. attribute:: version
Response's version, :class:`~aiohttp.protocol.HttpVersion` instance.
.. attribute:: status
HTTP status code of response (:class:`int`), e.g. ``200``.
.. attribute:: reason
HTTP status reason of response (:class:`str`), e.g. ``"OK"``.
.. attribute:: ok
Boolean representation of HTTP status code (:class:`bool`).
``True`` if ``status`` is less than ``400``; otherwise, ``False``.
.. attribute:: method
Request's method (:class:`str`).
.. attribute:: url
URL of request (:class:`~yarl.URL`).
.. attribute:: real_url
Unmodified URL of request with URL fragment unstripped (:class:`~yarl.URL`).
.. versionadded:: 3.2
.. attribute:: connection
:class:`Connection` used for handling response.
.. attribute:: content
Payload stream, which contains response's BODY (:class:`StreamReader`).
It supports various reading methods depending on the expected format.
When chunked transfer encoding is used by the server, allows retrieving
the actual http chunks.
Reading from the stream may raise
:exc:`aiohttp.ClientPayloadError` if the response object is
closed before response receives all data or in case if any
transfer encoding related errors like malformed chunked
encoding of broken compression data.
.. attribute:: cookies
HTTP cookies of response (*Set-Cookie* HTTP header,
:class:`~http.cookies.SimpleCookie`).
.. attribute:: headers
A case-insensitive multidict proxy with HTTP headers of
response, :class:`~multidict.CIMultiDictProxy`.
.. attribute:: raw_headers
Unmodified HTTP headers of response as unconverted bytes, a sequence of
``(key, value)`` pairs.
.. attribute:: links
Link HTTP header parsed into a :class:`~multidict.MultiDictProxy`.
For each link, key is link param `rel` when it exists, or link url as
:class:`str` otherwise, and value is :class:`~multidict.MultiDictProxy`
of link params and url at key `url` as :class:`~yarl.URL` instance.
.. versionadded:: 3.2
.. attribute:: content_type
Read-only property with *content* part of *Content-Type* header.
.. note::
Returns value is ``'application/octet-stream'`` if no
Content-Type header present in HTTP headers according to
:rfc:`2616`. To make sure Content-Type header is not present in
the server reply, use :attr:`headers` or :attr:`raw_headers`, e.g.
``'CONTENT-TYPE' not in resp.headers``.
.. attribute:: charset
Read-only property that specifies the *encoding* for the request's BODY.
The value is parsed from the *Content-Type* HTTP header.
Returns :class:`str` like ``'utf-8'`` or ``None`` if no *Content-Type*
header present in HTTP headers or it has no charset information.
.. attribute:: content_disposition
Read-only property that specified the *Content-Disposition* HTTP header.
Instance of :class:`ContentDisposition` or ``None`` if no *Content-Disposition*
header present in HTTP headers.
.. attribute:: history
A :class:`~collections.abc.Sequence` of :class:`ClientResponse`
objects of preceding requests (earliest request first) if there were
redirects, an empty sequence otherwise.
.. method:: close()
Close response and underlying connection.
For :term:`keep-alive` support see :meth:`release`.
.. method:: read()
:async:
Read the whole response's body as :class:`bytes`.
Close underlying connection if data reading gets an error,
release connection otherwise.
Raise an :exc:`aiohttp.ClientResponseError` if the data can't
be read.
:return bytes: read *BODY*.
.. seealso:: :meth:`close`, :meth:`release`.
.. method:: release()
It is not required to call `release` on the response
object. When the client fully receives the payload, the
underlying connection automatically returns back to pool. If the
payload is not fully read, the connection is closed
.. method:: raise_for_status()
Raise an :exc:`aiohttp.ClientResponseError` if the response
status is 400 or higher.
Do nothing for success responses (less than 400).
.. method:: text(encoding=None)
:async:
Read response's body and return decoded :class:`str` using
specified *encoding* parameter.
If *encoding* is ``None`` content encoding is determined from the
Content-Type header, or using the ``fallback_charset_resolver`` function.
Close underlying connection if data reading gets an error,
release connection otherwise.
:param str encoding: text encoding used for *BODY* decoding, or
``None`` for encoding autodetection
(default).
:raises: :exc:`UnicodeDecodeError` if decoding fails. See also
:meth:`get_encoding`.
:return str: decoded *BODY*
.. method:: json(*, encoding=None, loads=json.loads, \
content_type='application/json')
:async:
Read response's body as *JSON*, return :class:`dict` using
specified *encoding* and *loader*. If data is not still available
a ``read`` call will be done.
If response's `content-type` does not match `content_type` parameter
:exc:`aiohttp.ContentTypeError` get raised.
To disable content type check pass ``None`` value.
:param str encoding: text encoding used for *BODY* decoding, or
``None`` for encoding autodetection
(default).
By the standard JSON encoding should be
``UTF-8`` but practice beats purity: some
servers return non-UTF
responses. Autodetection works pretty fine
anyway.
:param collections.abc.Callable loads: :term:`callable` used for loading *JSON*
data, :func:`json.loads` by default.
:param str content_type: specify response's content-type, if content type
does not match raise :exc:`aiohttp.ClientResponseError`.
To disable `content-type` check, pass ``None`` as value.
(default: `application/json`).
:return: *BODY* as *JSON* data parsed by *loads* parameter or
``None`` if *BODY* is empty or contains white-spaces only.
.. attribute:: request_info
A namedtuple with request URL and headers from :class:`~aiohttp.ClientRequest`
object, :class:`aiohttp.RequestInfo` instance.
.. method:: get_encoding()
Retrieve content encoding using ``charset`` info in ``Content-Type`` HTTP header.
If no charset is present or the charset is not understood by Python, the
``fallback_charset_resolver`` function associated with the ``ClientSession`` is called.
.. versionadded:: 3.0
ClientWebSocketResponse
-----------------------
To connect to a websocket server :func:`aiohttp.ws_connect` or
:meth:`aiohttp.ClientSession.ws_connect` coroutines should be used, do
not create an instance of class :class:`ClientWebSocketResponse`
manually.
.. class:: ClientWebSocketResponse()
Class for handling client-side websockets.
.. attribute:: closed
Read-only property, ``True`` if :meth:`close` has been called or
:const:`~aiohttp.WSMsgType.CLOSE` message has been received from peer.
.. attribute:: protocol
Websocket *subprotocol* chosen after :meth:`start` call.
May be ``None`` if server and client protocols are
not overlapping.
.. method:: get_extra_info(name, default=None)
Reads optional extra information from the connection's transport.
If no value associated with ``name`` is found, ``default`` is returned.
See :meth:`asyncio.BaseTransport.get_extra_info`
:param str name: The key to look up in the transport extra information.
:param default: Default value to be used when no value for ``name`` is
found (default is ``None``).
.. method:: exception()
Returns exception if any occurs or returns None.
.. method:: ping(message=b'')
:async:
Send :const:`~aiohttp.WSMsgType.PING` to peer.
:param message: optional payload of *ping* message,
:class:`str` (converted to *UTF-8* encoded bytes)
or :class:`bytes`.
.. versionchanged:: 3.0
The method is converted into :term:`coroutine`
.. method:: pong(message=b'')
:async:
Send :const:`~aiohttp.WSMsgType.PONG` to peer.
:param message: optional payload of *pong* message,
:class:`str` (converted to *UTF-8* encoded bytes)
or :class:`bytes`.
.. versionchanged:: 3.0
The method is converted into :term:`coroutine`
.. method:: send_str(data, compress=None)
:async:
Send *data* to peer as :const:`~aiohttp.WSMsgType.TEXT` message.
:param str data: data to send.
:param int compress: sets specific level of compression for
single message,
``None`` for not overriding per-socket setting.
:raise TypeError: if data is not :class:`str`
.. versionchanged:: 3.0
The method is converted into :term:`coroutine`,
*compress* parameter added.
.. method:: send_bytes(data, compress=None)
:async:
Send *data* to peer as :const:`~aiohttp.WSMsgType.BINARY` message.
:param data: data to send.
:param int compress: sets specific level of compression for
single message,
``None`` for not overriding per-socket setting.
:raise TypeError: if data is not :class:`bytes`,
:class:`bytearray` or :class:`memoryview`.
.. versionchanged:: 3.0
The method is converted into :term:`coroutine`,
*compress* parameter added.
.. method:: send_json(data, compress=None, *, dumps=json.dumps)
:async:
Send *data* to peer as JSON string.
:param data: data to send.
:param int compress: sets specific level of compression for
single message,
``None`` for not overriding per-socket setting.
:param collections.abc.Callable dumps: any :term:`callable` that accepts an object and
returns a JSON string
(:func:`json.dumps` by default).
:raise RuntimeError: if connection is not started or closing
:raise ValueError: if data is not serializable object
:raise TypeError: if value returned by ``dumps(data)`` is not
:class:`str`
.. versionchanged:: 3.0
The method is converted into :term:`coroutine`,
*compress* parameter added.
.. method:: close(*, code=WSCloseCode.OK, message=b'')
:async:
A :ref:`coroutine<coroutine>` that initiates closing handshake by sending
:const:`~aiohttp.WSMsgType.CLOSE` message. It waits for
close response from server. To add a timeout to `close()` call
just wrap the call with `asyncio.wait()` or `asyncio.wait_for()`.
:param int code: closing code. See also :class:`~aiohttp.WSCloseCode`.
:param message: optional payload of *close* message,
:class:`str` (converted to *UTF-8* encoded bytes) or :class:`bytes`.
.. method:: receive()
:async:
A :ref:`coroutine<coroutine>` that waits upcoming *data*
message from peer and returns it.
The coroutine implicitly handles
:const:`~aiohttp.WSMsgType.PING`,
:const:`~aiohttp.WSMsgType.PONG` and
:const:`~aiohttp.WSMsgType.CLOSE` without returning the
message.
It process *ping-pong game* and performs *closing handshake* internally.
:return: :class:`~aiohttp.WSMessage`
.. method:: receive_str()
:async:
A :ref:`coroutine<coroutine>` that calls :meth:`receive` but
also asserts the message type is
:const:`~aiohttp.WSMsgType.TEXT`.
:return str: peer's message content.
:raise TypeError: if message is :const:`~aiohttp.WSMsgType.BINARY`.
.. method:: receive_bytes()
:async:
A :ref:`coroutine<coroutine>` that calls :meth:`receive` but
also asserts the message type is
:const:`~aiohttp.WSMsgType.BINARY`.
:return bytes: peer's message content.
:raise TypeError: if message is :const:`~aiohttp.WSMsgType.TEXT`.
.. method:: receive_json(*, loads=json.loads)
:async:
A :ref:`coroutine<coroutine>` that calls :meth:`receive_str` and loads
the JSON string to a Python dict.
:param collections.abc.Callable loads: any :term:`callable` that accepts
:class:`str` and returns :class:`dict`
with parsed JSON (:func:`json.loads` by
default).
:return dict: loaded JSON content
:raise TypeError: if message is :const:`~aiohttp.WSMsgType.BINARY`.
:raise ValueError: if message is not valid JSON.
Utilities
---------
.. class:: ClientTimeout(*, total=None, connect=None, \
sock_connect=None, sock_read=None)
A data class for client timeout settings.
See :ref:`aiohttp-client-timeouts` for usage examples.
.. attribute:: total
Total number of seconds for the whole request.
:class:`float`, ``None`` by default.
.. attribute:: connect
Maximal number of seconds for acquiring a connection from pool. The time
consists connection establishment for a new connection or
waiting for a free connection from a pool if pool connection
limits are exceeded.
For pure socket connection establishment time use
:attr:`sock_connect`.
:class:`float`, ``None`` by default.
.. attribute:: sock_connect
Maximal number of seconds for connecting to a peer for a new connection, not
given from a pool. See also :attr:`connect`.
:class:`float`, ``None`` by default.
.. attribute:: sock_read
Maximal number of seconds for reading a portion of data from a peer.
:class:`float`, ``None`` by default.
.. versionadded:: 3.3
.. note::
Timeouts of 5 seconds or more are rounded for scheduling on the next
second boundary (an absolute time where microseconds part is zero) for the
sake of performance.
E.g., assume a timeout is ``10``, absolute time when timeout should expire
is ``loop.time() + 5``, and it points to ``12345.67 + 10`` which is equal
to ``12355.67``.
The absolute time for the timeout cancellation is ``12356``.
It leads to grouping all close scheduled timeout expirations to exactly
the same time to reduce amount of loop wakeups.
.. versionchanged:: 3.7
Rounding to the next seconds boundary is disabled for timeouts smaller
than 5 seconds for the sake of easy debugging.
In turn, tiny timeouts can lead to significant performance degradation
on production environment.
.. class:: ETag(name, is_weak=False)
Represents `ETag` identifier.
.. attribute:: value
Value of corresponding etag without quotes.
.. attribute:: is_weak
Flag indicates that etag is weak (has `W/` prefix).
.. versionadded:: 3.8
.. class:: RequestInfo()
A data class with request URL and headers from :class:`~aiohttp.ClientRequest`
object, available as :attr:`ClientResponse.request_info` attribute.
.. attribute:: url
Requested *url*, :class:`yarl.URL` instance.
.. attribute:: method
Request HTTP method like ``'GET'`` or ``'POST'``, :class:`str`.
.. attribute:: headers
HTTP headers for request, :class:`multidict.CIMultiDict` instance.
.. attribute:: real_url
Requested *url* with URL fragment unstripped, :class:`yarl.URL` instance.
.. versionadded:: 3.2
.. class:: BasicAuth(login, password='', encoding='latin1')
HTTP basic authentication helper.
:param str login: login
:param str password: password
:param str encoding: encoding (``'latin1'`` by default)
Should be used for specifying authorization data in client API,
e.g. *auth* parameter for :meth:`ClientSession.request() <aiohttp.ClientSession.request>`.
.. classmethod:: decode(auth_header, encoding='latin1')
Decode HTTP basic authentication credentials.
:param str auth_header: The ``Authorization`` header to decode.
:param str encoding: (optional) encoding ('latin1' by default)
:return: decoded authentication data, :class:`BasicAuth`.
.. classmethod:: from_url(url)
Constructed credentials info from url's *user* and *password*
parts.
:return: credentials data, :class:`BasicAuth` or ``None`` is
credentials are not provided.
.. versionadded:: 2.3
.. method:: encode()
Encode credentials into string suitable for ``Authorization``
header etc.
:return: encoded authentication data, :class:`str`.
.. class:: CookieJar(*, unsafe=False, quote_cookie=True, treat_as_secure_origin = [])
The cookie jar instance is available as :attr:`ClientSession.cookie_jar`.
The jar contains :class:`~http.cookies.Morsel` items for storing
internal cookie data.
API provides a count of saved cookies::
len(session.cookie_jar)
These cookies may be iterated over::
for cookie in session.cookie_jar:
print(cookie.key)
print(cookie["domain"])
The class implements :class:`collections.abc.Iterable`,
:class:`collections.abc.Sized` and
:class:`aiohttp.abc.AbstractCookieJar` interfaces.
Implements cookie storage adhering to RFC 6265.
:param bool unsafe: (optional) Whether to accept cookies from IPs.
:param bool quote_cookie: (optional) Whether to quote cookies according to
:rfc:`2109`. Some backend systems
(not compatible with RFC mentioned above)
does not support quoted cookies.
.. versionadded:: 3.7
:param treat_as_secure_origin: (optional) Mark origins as secure
for cookies marked as Secured. Possible types are
Possible types are:
- :class:`tuple` or :class:`list` of
:class:`str` or :class:`yarl.URL`
- :class:`str`
- :class:`yarl.URL`
.. versionadded:: 3.8
.. method:: update_cookies(cookies, response_url=None)
Update cookies returned by server in ``Set-Cookie`` header.
:param cookies: a :class:`collections.abc.Mapping`
(e.g. :class:`dict`, :class:`~http.cookies.SimpleCookie`) or
*iterable* of *pairs* with cookies returned by server's
response.
:param ~yarl.URL response_url: URL of response, ``None`` for *shared
cookies*. Regular cookies are coupled with server's URL and
are sent only to this server, shared ones are sent in every
client request.
.. method:: filter_cookies(request_url)
Return jar's cookies acceptable for URL and available in
``Cookie`` header for sending client requests for given URL.
:param ~yarl.URL response_url: request's URL for which cookies are asked.
:return: :class:`http.cookies.SimpleCookie` with filtered
cookies for given URL.
.. method:: save(file_path)
Write a pickled representation of cookies into the file
at provided path.
:param file_path: Path to file where cookies will be serialized,
:class:`str` or :class:`pathlib.Path` instance.
.. method:: load(file_path)
Load a pickled representation of cookies from the file
at provided path.
:param file_path: Path to file from where cookies will be
imported, :class:`str` or :class:`pathlib.Path` instance.
.. method:: clear(predicate=None)
Removes all cookies from the jar if the predicate is ``None``. Otherwise remove only those :class:`~http.cookies.Morsel` that ``predicate(morsel)`` returns ``True``.
:param predicate: callable that gets :class:`~http.cookies.Morsel` as a parameter and returns ``True`` if this :class:`~http.cookies.Morsel` must be deleted from the jar.
.. versionadded:: 4.0
.. method:: clear_domain(domain)
Remove all cookies from the jar that belongs to the specified domain or its subdomains.
:param str domain: domain for which cookies must be deleted from the jar.
.. versionadded:: 4.0
.. class:: DummyCookieJar(*, loop=None)
Dummy cookie jar which does not store cookies but ignores them.
Could be useful e.g. for web crawlers to iterate over Internet
without blowing up with saved cookies information.
To install dummy cookie jar pass it into session instance::
jar = aiohttp.DummyCookieJar()
session = aiohttp.ClientSession(cookie_jar=DummyCookieJar())
.. class:: Fingerprint(digest)
Fingerprint helper for checking SSL certificates by *SHA256* digest.
:param bytes digest: *SHA256* digest for certificate in DER-encoded
binary form (see
:meth:`ssl.SSLSocket.getpeercert`).
To check fingerprint pass the object into :meth:`ClientSession.get`
call, e.g.::
import hashlib
with open(path_to_cert, 'rb') as f:
digest = hashlib.sha256(f.read()).digest()
await session.get(url, ssl=aiohttp.Fingerprint(digest))
.. versionadded:: 3.0
FormData
^^^^^^^^
A :class:`FormData` object contains the form data and also handles
encoding it into a body that is either ``multipart/form-data`` or
``application/x-www-form-urlencoded``. ``multipart/form-data`` is
used if at least one field is an :class:`io.IOBase` object or was
added with at least one optional argument to :meth:`add_field<aiohttp.FormData.add_field>`
(``content_type``, ``filename``, or ``content_transfer_encoding``).
Otherwise, ``application/x-www-form-urlencoded`` is used.
:class:`FormData` instances are callable and return a :class:`aiohttp.payload.Payload`
on being called.
.. class:: FormData(fields, quote_fields=True, charset=None)
Helper class for multipart/form-data and application/x-www-form-urlencoded body generation.
:param fields: A container for the key/value pairs of this form.
Possible types are:
- :class:`dict`
- :class:`tuple` or :class:`list`
- :class:`io.IOBase`, e.g. a file-like object
- :class:`multidict.MultiDict` or :class:`multidict.MultiDictProxy`
If it is a :class:`tuple` or :class:`list`, it must be a valid argument
for :meth:`add_fields<aiohttp.FormData.add_fields>`.
For :class:`dict`, :class:`multidict.MultiDict`, and :class:`multidict.MultiDictProxy`,
the keys and values must be valid `name` and `value` arguments to
:meth:`add_field<aiohttp.FormData.add_field>`, respectively.
.. method:: add_field(name, value, content_type=None, filename=None,\
content_transfer_encoding=None)
Add a field to the form.
:param str name: Name of the field
:param value: Value of the field
Possible types are:
- :class:`str`
- :class:`bytes`, :class:`bytearray`, or :class:`memoryview`
- :class:`io.IOBase`, e.g. a file-like object
:param str content_type: The field's content-type header (optional)
:param str filename: The field's filename (optional)
If this is not set and ``value`` is a :class:`bytes`, :class:`bytearray`,
or :class:`memoryview` object, the `name` argument is used as the filename
unless ``content_transfer_encoding`` is specified.
If ``filename`` is not set and ``value`` is an :class:`io.IOBase`
object, the filename is extracted from the object if possible.
:param str content_transfer_encoding: The field's content-transfer-encoding
header (optional)
.. method:: add_fields(fields)
Add one or more fields to the form.
:param fields: An iterable containing:
- :class:`io.IOBase`, e.g. a file-like object
- :class:`multidict.MultiDict` or :class:`multidict.MultiDictProxy`
- :class:`tuple` or :class:`list` of length two, containing a name-value pair
Client exceptions
-----------------
Exception hierarchy has been significantly modified in version
2.0. aiohttp defines only exceptions that covers connection handling
and server response misbehaviors. For developer specific mistakes,
aiohttp uses python standard exceptions like :exc:`ValueError` or
:exc:`TypeError`.
Reading a response content may raise a :exc:`ClientPayloadError`
exception. This exception indicates errors specific to the payload
encoding. Such as invalid compressed data, malformed chunked-encoded
chunks or not enough data that satisfy the content-length header.
All exceptions are available as members of *aiohttp* module.
.. exception:: ClientError
Base class for all client specific exceptions.
Derived from :exc:`Exception`
.. class:: ClientPayloadError
This exception can only be raised while reading the response
payload if one of these errors occurs:
1. invalid compression
2. malformed chunked encoding
3. not enough data that satisfy ``Content-Length`` HTTP header.
Derived from :exc:`ClientError`
.. exception:: InvalidURL
URL used for fetching is malformed, e.g. it does not contain host
part.
Derived from :exc:`ClientError` and :exc:`ValueError`
.. attribute:: url
Invalid URL, :class:`yarl.URL` instance.
.. attribute:: description
Invalid URL description, :class:`str` instance or :data:`None`.
.. exception:: InvalidUrlClientError
Base class for all errors related to client url.
Derived from :exc:`InvalidURL`
.. exception:: RedirectClientError
Base class for all errors related to client redirects.
Derived from :exc:`ClientError`
.. exception:: NonHttpUrlClientError
Base class for all errors related to non http client urls.
Derived from :exc:`ClientError`
.. exception:: InvalidUrlRedirectClientError
Redirect URL is malformed, e.g. it does not contain host part.
Derived from :exc:`InvalidUrlClientError` and :exc:`RedirectClientError`
.. exception:: NonHttpUrlRedirectClientError
Redirect URL does not contain http schema.
Derived from :exc:`RedirectClientError` and :exc:`NonHttpUrlClientError`
.. class:: ContentDisposition
Represent Content-Disposition header
.. attribute:: type
A :class:`str` instance. Value of Content-Disposition header
itself, e.g. ``attachment``.
.. attribute:: filename
A :class:`str` instance. Content filename extracted from
parameters. May be ``None``.
.. attribute:: parameters
Read-only mapping contains all parameters.
Response errors
^^^^^^^^^^^^^^^
.. exception:: ClientResponseError
These exceptions could happen after we get response from server.
Derived from :exc:`ClientError`
.. attribute:: request_info
Instance of :class:`RequestInfo` object, contains information
about request.
.. attribute:: status
HTTP status code of response (:class:`int`), e.g. ``400``.
.. attribute:: message
Message of response (:class:`str`), e.g. ``"OK"``.
.. attribute:: headers
Headers in response, a list of pairs.
.. attribute:: history
History from failed response, if available, else empty tuple.
A :class:`tuple` of :class:`ClientResponse` objects used for
handle redirection responses.
.. attribute:: code
HTTP status code of response (:class:`int`), e.g. ``400``.
.. deprecated:: 3.1
.. class:: ContentTypeError
Invalid content type.
Derived from :exc:`ClientResponseError`
.. versionadded:: 2.3
.. class:: TooManyRedirects
Client was redirected too many times.
Maximum number of redirects can be configured by using
parameter ``max_redirects`` in :meth:`request<aiohttp.ClientSession.request>`.
Derived from :exc:`ClientResponseError`
.. versionadded:: 3.2
.. class:: WSServerHandshakeError
Web socket server response error.
Derived from :exc:`ClientResponseError`
Connection errors
^^^^^^^^^^^^^^^^^
.. class:: ClientConnectionError
These exceptions related to low-level connection problems.
Derived from :exc:`ClientError`
.. class:: ClientOSError
Subset of connection errors that are initiated by an :exc:`OSError`
exception.
Derived from :exc:`ClientConnectionError` and :exc:`OSError`
.. class:: ClientConnectorError
Connector related exceptions.
Derived from :exc:`ClientOSError`
.. class:: ClientProxyConnectionError
Derived from :exc:`ClientConnectorError`
.. class:: ClientSSLError
Derived from :exc:`ClientConnectorError`
.. class:: ClientConnectorSSLError
Response ssl error.
Derived from :exc:`ClientSSLError` and :exc:`ssl.SSLError`
.. class:: ClientConnectorCertificateError
Response certificate error.
Derived from :exc:`ClientSSLError` and :exc:`ssl.CertificateError`
.. class:: UnixClientConnectorError
Derived from :exc:`ClientConnectorError`
.. class:: ServerConnectionError
Derived from :exc:`ClientConnectionError`
.. class:: ServerDisconnectedError
Server disconnected.
Derived from :exc:`~aiohttp.ServerConnectionError`
.. attribute:: message
Partially parsed HTTP message (optional).
.. class:: ServerFingerprintMismatch
Server fingerprint mismatch.
Derived from :exc:`ServerConnectionError`
.. class:: ServerTimeoutError
Server operation timeout: read timeout, etc.
Derived from :exc:`ServerConnectionError` and :exc:`asyncio.TimeoutError`
.. class:: ConnectionTimeoutError
Connection timeout on request: e.g. read timeout.
Derived from :exc:`ServerTimeoutError`
.. class:: SocketTimeoutError
Reading from socket timeout.
Derived from :exc:`ServerTimeoutError`
Hierarchy of exceptions
^^^^^^^^^^^^^^^^^^^^^^^
* :exc:`ClientError`
* :exc:`ClientConnectionError`
* :exc:`ClientOSError`
* :exc:`ClientConnectorError`
* :exc:`ClientProxyConnectionError`
* :exc:`ClientSSLError`
* :exc:`ClientConnectorCertificateError`
* :exc:`ClientConnectorSSLError`
* :exc:`UnixClientConnectorError`
* :exc:`ServerConnectionError`
* :exc:`ServerDisconnectedError`
* :exc:`ServerFingerprintMismatch`
* :exc:`ServerTimeoutError`
* :exc:`ConnectionTimeoutError`
* :exc:`SocketTimeoutError`
* :exc:`ClientPayloadError`
* :exc:`ClientResponseError`
* :exc:`~aiohttp.ClientHttpProxyError`
* :exc:`ContentTypeError`
* :exc:`TooManyRedirects`
* :exc:`WSServerHandshakeError`
* :exc:`InvalidURL`
* :exc:`InvalidUrlClientError`
* :exc:`InvalidUrlRedirectClientError`
* :exc:`NonHttpUrlClientError`
* :exc:`NonHttpUrlRedirectClientError`
* :exc:`RedirectClientError`
* :exc:`InvalidUrlRedirectClientError`
* :exc:`NonHttpUrlRedirectClientError`
|