HTTP client (earthlens.base.http)#
HttpClient is the shared requests-based transport for the REST-style backends. It owns the chores every
backend used to hand-roll — a pooled session, a sensible User-Agent, a per-request timeout, a
Retry-After-aware 429/5xx back-off loop, JSON decoding, and a streamed download with a progress bar — so a
new backend keeps only the API-shaped parts: endpoint paths, query params, pagination, auth-header values, and
response parsing.
Don't hand-roll a session or a retry loop. If you find yourself writing
requests.Session(), awhileloop that inspects429/Retry-After, or aniter_contentchunk loop, reach forHttpClientinstead. Backends that pre-date it are being migrated onto it.
Consuming it#
Construct one client per backend with the default headers it needs, then call the verbs:
from earthlens.base.http import HttpClient
http = HttpClient(headers={"X-API-Key": api_key})
# JSON GET with automatic status + transport retry and Retry-After honouring:
payload = http.get_json("https://api.example.org/v1/things", params={"bbox": "1,2,3,4"})
# Streamed download to disk with a tqdm bar (sized from Content-Length):
http.download("https://example.org/big.tif", dest, progress=True)
Retry policy#
Two kinds of failure are retried, on separate budgets, because they warrant opposite policies.
Status retries cover 429 / 500 / 502 / 503 / 504 and honour Retry-After. A 413 / 429 / 503
is the server asking for a later attempt, so it is replayed for any method. A 500 / 502 / 504 means the
server already had the request and may have acted on it, so those are replayed only for idempotent methods.
Transport retries cover the failures that never reach a status line — a refused or reset connection, a DNS blip, a read timeout, a body truncated mid-stream. These are on by default; they were opt-in before, which meant a TCP reset partway through a large granule threw away the whole transfer.
The two phases have their own budgets:
| Failure | Budget | Replayed for a POST? |
|---|---|---|
| connect — refused, unresolvable, connect timeout | connect_retries (1) |
yes — the request never reached the server |
| read — reset mid-response, read timeout, truncated body | read_retries (= max_retries) |
no, unless retry_unsafe_methods=True |
SSLError, ProxyError |
never retried under the default set | — |
A backend that already wraps its calls in its own retry or resilience loop now has two layers: the client retries
the transport, and the backend retries the call. The budgets multiply rather than add, so an outer loop of 3 over a
client of 5 is up to 18 attempts. If that is not what you want, pass retry_on_exceptions=() to opt the client's
transport retry out and keep the outer loop as the single authority.
If your endpoint is a POST that is safe to replay — a search or query API, an idempotent RPC — pass
retry_unsafe_methods=True. Without it neither a transport failure nor a 5xx is replayed for that verb, and
the suppression is logged at debug level rather than being silent.
The connect budget is small on purpose: a host that refuses a connection rarely starts accepting one within a back-off window, so a generous budget only turns a clear failure into a slow one.
timeout is a (connect, read) pair by default — (10.0, 60.0) — so a dead host fails in ten seconds while a
slow transfer keeps a full read budget. A bare float still works and applies to both phases.
The default User-Agent is earthlens/{version} — deliberately non-Mozilla, because the DIGITAL.CSIC
Anubis anti-bot wall (SPEIbase) blocks browser-like agents. Pass user_agent= for a descriptive contact string
(e.g. Overpass / ohsome etiquette).
Downloads read the whole object, and verify it#
By default download reads the object once, whole, on every attempt: it generates no Range header of its
own, and a retry re-requests from byte 0 rather than appending to what is already on disk. Resuming is available
but opt-in — see Resuming a single file below.
Restarting is the default because appending to a partial file is only safe if the new bytes provably belong to
the same representation as the old ones, and most servers do not give you enough to prove it: Accept-Ranges: bytes is advertised by hosts that then ignore Range and send the
whole body from zero; Last-Modified has one-second resolution, so a validator can match across a real change;
and a server may answer 416 without the Content-Range that would say how much it actually has. Every one of
those produces a file that is the right size and the wrong bytes — corruption that survives to the user
rather than failing loudly. The opt-in path below refuses to resume unless the server clears every one of those
hazards.
What replaces it is verification after the fact:
| Response | download does |
|---|---|
a body matching its Content-Length |
publishes it |
| a body short of it | raises IncompleteDownloadError, retrying from the start until the read budget or a repeated byte count stops it |
| a body longer than it, or the same short count twice | raises IncompleteDownloadError without retrying — both repeat |
no usable length (chunked, Content-Encoding, contradictory duplicates) |
publishes it unchecked; there is no claim to check |
a 206 to a request that carried no Range |
raises UnsolicitedPartialContentError without retrying |
| a break after the last byte, when the size already matches | keeps it; the equality is the whole proof |
The table above is what verify_length=True (the default) buys. Pass verify_length=False for a server that
misreports the size of a body it generates on the fly, where the check would fail a download that is actually
fine. It distrusts the advertised length in both directions, so an over-long body is published too, and it
disables the salvage, whose proof is the same size equality. It cannot be combined with resume=True, which is
addressed by that same length — the pair raises ValueError.
Because the check compares against bytes as delivered, download sends Accept-Encoding: identity — but only
when neither the call nor the constructor named that header in any casing, so a backend that needs gzip, or
that sets identity itself to protect a magic check, keeps what it asked for.
A Range you pass yourself is honoured verbatim: the response is accepted at its own Content-Length, and
download does not check that the server returned the range you asked for.
Interrupted multi-file jobs resume at file granularity — _is_complete() skips the granules already on disk
(see contracts).
Resuming a single file (resume=True)#
Within one file, download(url, dest, resume=True) will continue a broken transfer instead of re-reading it. It
is off by default: everything above is what the other callers get.
Resume is only attempted when the first response proved it is possible — a 200 advertising
Accept-Ranges: bytes, a known Content-Length, no content coding, and a strong ETag. A weak tag
(W/"...") never arms, and Last-Modified is never used: its one-second resolution matches across a change made
inside the same second.
Arming is the cheap half. A strong ETag is not sufficient — measured, data.worldpop.org sends one and then
answers a Range with 200 and the whole body. So the binding checks are on the reply, and all must hold before
one byte is appended:
| check | why |
|---|---|
status is 206 |
absorbs the 200-with-the-whole-object case, a 416, a redirect, an error status |
Content-Range start, end and total all match what was asked |
the object has not been replaced or re-cut |
ETag still names the anchored representation |
a 206 may not rename what If-Range selected |
| no content or transfer coding | Range addresses the encoded octets; the staged count is of decoded ones |
| the first 64 KiB re-send a window already on disk and match it byte for byte | see below |
That last one is the only check that reads the body. Every other gate compares one server claim against another,
so a server deriving a truthful Content-Range from the request while streaming a different slice satisfies all
of them. Re-reading a window we already hold is what makes the append safe.
Anything else discards the staged bytes and re-reads the whole object, and resume then stays off for the rest of
the call — so a badly-behaved server costs exactly one extra request, not a restart/resume cycle. Only bytes
this call wrote are ever built on, so a .part left by a killed run is never mistaken for a prefix, and the
assembled file passes the same length and expect_magic gates as a whole-object read.
Measured: geofabrik, DWD radklim (13.5 GB) and GHSL all emit strong ETags and honour Range exactly; worldpop
and Zenodo do not arm or are refused.
Testability#
Both the transport and the wait are injectable, so the whole client is unit-testable with a fake session and no real delays:
Pagination and response-envelope parsing stay in each backend — the client owns only how bytes move, never
the API shape.
API#
earthlens.base.http.HttpClient
#
Reusable HTTP transport: session, headers, timeout, retry, download.
Wraps a :class:requests.Session, attaching default headers (a
non-Mozilla User-Agent and Accept-Encoding: gzip, deflate) to
every request and applying a shared timeout. The verbs
(:meth:get, :meth:post, :meth:request) route through a
Retry-After-aware back-off loop; :meth:get_json decodes the JSON
body and :meth:download streams a response to disk. Both the
session and the sleep function are injectable so the client is fully
unit-testable without a live network.
Default headers set at construction are merged with (and overridden
by) any per-request headers=, so a backend expresses its quirks —
openaq's X-API-Key, a descriptive osm contact User-Agent — without
subclassing.
Attributes:
| Name | Type | Description |
|---|---|---|
timeout |
Per-request timeout in seconds — a single float, or a
|
|
max_retries |
Maximum retries on a retryable status before raising. |
|
backoff_factor |
Base seconds for exponential back-off when no
|
|
status_forcelist |
HTTP statuses that trigger a retry. |
|
max_backoff |
Ceiling in seconds on any single retry wait. |
|
retry_on_exceptions |
Transport exception types that trigger a retry. |
|
connect_retries |
Retry budget for connect-phase failures. |
|
read_retries |
Retry budget for read-phase failures. |
|
retry_unsafe_methods |
Whether a read-phase failure may replay a
non-idempotent verb such as |
|
raise_for_status |
Whether the final response is |
|
min_interval |
Minimum seconds between consecutive requests. |
Examples:
- The default agent is non-Mozilla and version-stamped:
Source code in libs/core/src/earthlens/base/http.py
1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 | |
default_headers
property
#
Return a copy of the headers merged onto every request.
session
property
#
Return the underlying :class:requests.Session.
__init__(*, session=None, user_agent=None, headers=None, timeout=DEFAULT_TIMEOUT, max_retries=DEFAULT_MAX_RETRIES, backoff_factor=DEFAULT_BACKOFF_FACTOR, status_forcelist=DEFAULT_STATUS_FORCELIST, max_backoff=DEFAULT_MAX_BACKOFF, retry_on_exceptions=None, connect_retries=None, read_retries=DEFAULT_READ_RETRIES, retry_unsafe_methods=False, retry_predicate=None, raise_for_status=True, min_interval=0.0, clock=time.monotonic, sleep=time.sleep)
#
Build a client with default headers, timeout, and retry policy.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
session
|
Session | None
|
An existing :class: |
None
|
user_agent
|
str | None
|
The default |
None
|
headers
|
dict[str, str] | None
|
Extra default headers merged onto every request
(e.g. |
None
|
timeout
|
Timeout
|
Per-request timeout in seconds — a single float bounds
both the connect and read phases, or pass a |
DEFAULT_TIMEOUT
|
max_retries
|
int
|
Maximum retries on a retryable status before the last response's error is raised. |
DEFAULT_MAX_RETRIES
|
backoff_factor
|
float
|
Base seconds for exponential back-off when a
response carries no |
DEFAULT_BACKOFF_FACTOR
|
status_forcelist
|
tuple[int, ...]
|
HTTP statuses that trigger a retry. |
DEFAULT_STATUS_FORCELIST
|
max_backoff
|
float | None
|
Ceiling in seconds on any single retry wait, so a
large |
DEFAULT_MAX_BACKOFF
|
retry_on_exceptions
|
tuple[type[BaseException], ...] | None
|
Exception types that also trigger a retry
when raised by the transport. |
None
|
connect_retries
|
int | None
|
Retries allowed for a failure in the connect
phase, counted separately from |
None
|
read_retries
|
int | None
|
Retries allowed for a failure after the connection
was established — a reset mid-response, a read timeout, a
truncated body. |
DEFAULT_READ_RETRIES
|
retry_unsafe_methods
|
bool
|
Whether a read-phase failure may replay a
non-idempotent verb. |
False
|
retry_predicate
|
Callable[[Response], bool] | None
|
An optional callback |
None
|
raise_for_status
|
bool
|
Whether to call |
True
|
min_interval
|
float
|
Minimum seconds between consecutive requests
(a proactive client-side rate limit). |
0.0
|
clock
|
Callable[[], float]
|
Monotonic clock used for the |
monotonic
|
sleep
|
Callable[[float], None]
|
The sleep function used between retries and for the
throttle. Defaults to :func: |
sleep
|
Source code in libs/core/src/earthlens/base/http.py
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 | |
download(url, dest, *, chunk=DEFAULT_CHUNK_SIZE, progress=True, atomic=True, expect_magic=None, headers=None, timeout=None, resume=False, verify_length=True, **kwargs)
#
Stream url to dest atomically, optionally showing a tqdm bar.
Absorbs the chunk-loop the streamed-download backends each
re-implement: streams with stream=True, sizes a progress bar
from Content-Length when present, and writes 1 MiB blocks. When
atomic (the default) it writes to a sibling <dest>.part and
renames on success, and it removes the temp on any failure — so a
crashed or interrupted download never leaves a truncated dest.
The whole download is retry-wrapped: a status in status_forcelist
or an exception in retry_on_exceptions retries the attempt (after
cleaning the temp), honouring the Retry-After/back-off policy.
By default every attempt reads the object once, whole, and the body
is verified after the fact: a response that advertised a
Content-Length must deliver exactly that many bytes, and a short read
is retried from the start. Pass resume=True to let a retry continue a
broken transfer instead of re-reading it; see that argument.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
url
|
str
|
Absolute request URL. |
required |
dest
|
str | Path
|
Output file path. Parent directories are created. |
required |
chunk
|
int
|
Streaming block size in bytes (default 1 MiB). |
DEFAULT_CHUNK_SIZE
|
progress
|
bool
|
Show a |
True
|
atomic
|
bool
|
Write to Two calls downloading the same |
True
|
expect_magic
|
bytes | tuple[bytes, ...] | None
|
One or more byte prefixes the body must start with
(e.g. |
None
|
headers
|
dict[str, str] | None
|
Per-request headers merged over the client defaults. |
None
|
timeout
|
Timeout | None
|
Per-request timeout override (seconds), as a single
float or a |
None
|
resume
|
bool
|
Continue a broken transfer with a ranged request instead
of re-reading the object, when — and only when — the server has
proved it can be done safely. Off by default; the whole-object
path above is unchanged for every caller that does not opt in.
It requires Three things make it inert, silently, so they are listed
together. It requires staging, so it does nothing under
On a leg A resumed request is only attempted when the first response
was a Only bytes this call wrote are ever built on, so a |
False
|
verify_length
|
bool
|
Compare the bytes written against the
Pass It is a separate switch from |
True
|
**kwargs
|
Any
|
Extra keyword arguments forwarded to |
{}
|
Returns:
| Name | Type | Description |
|---|---|---|
Path |
Path
|
The |
Raises:
| Type | Description |
|---|---|
ValueError
|
When |
UnsolicitedPartialContentError
|
When a |
IncompleteDownloadError
|
When the bytes written do not equal the
|
HTTPError
|
On an error status — |
ConnectionError
|
When a resumed leg is refused, the retry budget is spent, and the ranged reply carried no error status to report in its place. A refusal with budget left never escapes at all: the staged bytes are discarded, the object is re-read whole, and resume stays off for the rest of the call. |
BaseException
|
Once the transport retry budget is spent, the last transport failure is re-raised as a fresh instance of its own type, with a message naming the attempt count and the largest byte count any attempt reached. |
OSError
|
From |
Source code in libs/core/src/earthlens/base/http.py
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 | |
get_json(url, **kwargs)
#
Send a GET request and decode the JSON response body.
Convenience over :meth:get for the REST endpoints that return
JSON envelopes.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
url
|
str
|
Absolute request URL. |
required |
**kwargs
|
Any
|
Keyword arguments forwarded to :meth: |
{}
|
Returns:
| Type | Description |
|---|---|
Any
|
The parsed JSON body (typically a |
Raises:
| Type | Description |
|---|---|
HTTPError
|
On a non-retryable error status, or after the retryable status is exhausted. |
Source code in libs/core/src/earthlens/base/http.py
request(method, url, *, headers=None, timeout=None, raise_for_status=None, **kwargs)
#
Send one request with the default headers, timeout, and retry.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
method
|
str
|
HTTP verb ( |
required |
url
|
str
|
Absolute request URL. |
required |
headers
|
dict[str, str] | None
|
Per-request headers merged over the client defaults, and
passed through verbatim. A |
None
|
timeout
|
Timeout | None
|
Per-request timeout override (seconds), as a single
float or a |
None
|
raise_for_status
|
bool | None
|
Per-request override of the client's
|
None
|
**kwargs
|
Any
|
Extra keyword arguments forwarded to |
{}
|
Returns:
| Type | Description |
|---|---|
Response
|
requests.Response: The response (after |
Raises:
| Type | Description |
|---|---|
HTTPError
|
On a non-retryable error status, or after
the retryable status is exhausted (when |
Source code in libs/core/src/earthlens/base/http.py
stream(url, **kwargs)
#
Send a streaming GET (stream=True), retry-wrapped.
Returns the open response without consuming its body, so the
caller can iterate iter_content. Retries follow the same
Retry-After/back-off policy as the other verbs; the retry
decision reads only the status line, never the body.
A body that breaks after this returns is therefore the
caller's to handle: the iteration happens outside the retry loop,
so a ChunkedEncodingError raised mid-stream escapes it. The
default transport retry covers the non-streaming verbs, whose
bodies requests materialises inside the loop, and
:meth:download, which owns its own. A caller streaming a large
body that needs the same protection should use :meth:download
or re-request on failure itself.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
url
|
str
|
Absolute request URL. |
required |
**kwargs
|
Any
|
Keyword arguments forwarded to :meth: |
{}
|
Returns:
| Type | Description |
|---|---|
Response
|
requests.Response: The open streaming response. |