The next generation HTTP client.
Project description
http3
Feature support
HTTP/2andHTTP/1.1support.async/awaitsupport for non-blocking HTTP requests.- Strict timeouts everywhere by default.
- Fully type annotated.
- 100% test coverage.
Plus all the standard features of requests...
- International Domains and URLs
- Keep-Alive & Connection Pooling
- Sessions with Cookie Persistence
- Browser-style SSL Verification
- Basic/Digest Authentication TODO - We have Basic, but not Digest yet.
- Elegant Key/Value Cookies
- Automatic Decompression
- Automatic Content Decoding
- Unicode Response Bodies
- Multipart File Uploads TODO - Request content currently supports URL encoded data, JSON, bytes, or async byte iterators.
- HTTP(S) Proxy Support TODO
- Connection Timeouts
- Streaming Downloads
- .netrc Support TODO
- Chunked Requests
Usage
Making a request:
>>> import http3
>>> client = http3.Client()
>>> response = client.get('https://example.com')
>>> response.status_code
<HTTPStatus.OK: 200>
>>> response.protocol
'HTTP/2'
>>> response.text
'<!doctype html>\n<html>\n<head>\n<title>Example Domain</title>\n...'
Alternatively, async requests:
Note: Use ipython to try this from the console, since it supports await.
>>> import http3
>>> client = http3.AsyncClient()
>>> response = await client.get('https://example.com')
>>> response.status_code
<StatusCode.OK: 200>
>>> response.protocol
'HTTP/2'
>>> response.text
'<!doctype html>\n<html>\n<head>\n<title>Example Domain</title>\n...'
Dependencies
h2- HTTP/2 support.h11- HTTP/1.1 support.certifi- SSL certificates.chardet- Fallback auto-detection for response encoding.idna- Internationalized domain name support.rfc3986- URL parsing & normalization.brotlipy- Decoding for "brotli" compressed responses. (Optional)
A huge amount of credit is due to requests for the API layout that
much of this work follows, as well as to urllib3 for plenty of design
inspiration around the lower level networking details.
API Reference
Client
An HTTP client, with connection pooling, redirects, cookie persistence, etc.
>>> client = Client()
>>> response = client.get('https://example.org')
def __init__([auth], [cookies], [verify], [cert], [timeout], [pool_limits], [max_redirects], [dispatch])def .request(method, url, [data], [params], [headers], [cookies], [auth], [stream], [allow_redirects], [verify], [cert], [timeout])def .get(url, [params], [headers], [cookies], [auth], [stream], [allow_redirects], [verify], [cert], [timeout])def .options(url, [params], [headers], [cookies], [auth], [stream], [allow_redirects], [verify], [cert], [timeout])def .head(url, [params], [headers], [cookies], [auth], [stream], [allow_redirects], [verify], [cert], [timeout])def .post(url, [data], [json], [params], [headers], [cookies], [auth], [stream], [allow_redirects], [verify], [cert], [timeout])def .put(url, [data], [json], [params], [headers], [cookies], [auth], [stream], [allow_redirects], [verify], [cert], [timeout])def .patch(url, [data], [json], [params], [headers], [cookies], [auth], [stream], [allow_redirects], [verify], [cert], [timeout])def .delete(url, [data], [json], [params], [headers], [cookies], [auth], [stream], [allow_redirects], [verify], [cert], [timeout])def .send(request, [stream], [allow_redirects], [verify], [cert], [timeout])def .close()
Response
An HTTP response.
def __init__(...).status_code- int (Typically aStatusCodeIntEnum.).reason_phrase- str.protocol-"HTTP/2"or"HTTP/1.1".url- URL.headers- Headers.content- bytes.text- str.encoding- str.is_redirect- bool.request- Request.cookies- Cookies.history- List[Response]def .raise_for_status()- Nonedef .json()- Anydef .read()- bytesdef .stream()- bytes iteratordef .raw()- bytes iteratordef .close()- Nonedef .next()- Response
Request
An HTTP request. Can be constructed explicitly for more control over exactly what gets sent over the wire.
>>> request = Request("GET", "https://example.org", headers={'host': 'example.org'})
>>> response = client.send(request)
def __init__(method, url, [params], [data], [json], [headers], [cookies]).method- str.url- URL.content- byte or byte async iterator.headers- Headers.cookies- Cookies
URL
A normalized, IDNA supporting URL.
>>> url = URL("https://example.org/")
>>> url.host
'example.org'
def __init__(url, allow_relative=False, params=None).scheme- str.authority- str.host- str.port- int.path- str.query- str.full_path- str.fragment- str.is_ssl- bool.origin- Origin.is_absolute_url- bool.is_relative_url- booldef .copy_with([scheme], [authority], [path], [query], [fragment])- URLdef .resolve_with(url)- URL
Origin
A normalized, IDNA supporting set of scheme/host/port info.
>>> Origin('https://example.org') == Origin('HTTPS://EXAMPLE.ORG:443')
True
def __init__(url).is_ssl- bool.host- str.port- int
Headers
A case-insensitive multi-dict.
>>> headers = Headers({'Content-Type': 'application/json'})
>>> headers['content-type']
'application/json'
def __init__(self, headers)
Cookies
A dict-like cookie store.
>>> cookies = Cookies()
>>> cookies.set("name", "value", domain="example.org")
def __init__(cookies: [dict, Cookies, CookieJar]).jar- CookieJardef extract_cookies(response)def set_cookie_header(request)def set(name, value, [domain], [path])def get(name, [domain], [path])def delete(name, [domain], [path])def clear([domain], [path])- Standard mutable mapping interface
Alternate backends
AsyncClient
An asyncio client.
TrioClient
TODO
The Stack
There are two main layers in the stack. The client handles redirection, cookie persistence (TODO), and authentication (TODO). The dispatcher handles sending the actual request and getting the response.
Client- Redirect, authentication, cookies etc.ConnectionPool(Dispatcher)- Connection pooling & keep alive.HTTPConnection- A single connection.HTTP11Connection- A single HTTP/1.1 connection.HTTP2Connection- A single HTTP/2 connection, with multiple streams.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
http3-0.0.1.tar.gz
(31.0 kB
view details)
File details
Details for the file http3-0.0.1.tar.gz.
File metadata
- Download URL: http3-0.0.1.tar.gz
- Upload date:
- Size: 31.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3642c29681295a2bc99c25ad8c6aded9866c1ec52d26b9b4ef149858d1886419 |
|
| MD5 | b8677bc77a4060c453b4036474e515e2 |
|
| BLAKE2b-256 | b2c7218101ab63ac80c675928c8edfa3d65181abd51f79225f33f35621babfda |
