Friendly fork of the next generation HTTP client.
Project description
HTTPXYZ - A friendly fork of the next-generation HTTP client for Python.
HTTPXYZ (pronounced "HTTP-ex-why-zee") is a fully featured HTTP client library for Python 3. It includes an integrated command line client, has support for both HTTP/1.1 and HTTP/2, and provides both sync and async APIs.
About this fork
HTTPXYZ is a fork of HTTPX. HTTPX had no release after November 2024 while bugs affecting real-world usage went unresolved. Our goal is stability: bug fixes only, no breaking API changes.
We mean no harm to the original author or contributors — HTTPX is excellent work. For the full story, see Why we forked HTTPX.
Migrating from HTTPX
For most users, migration is a one-line change:
import httpxyz as httpx
That's it, HTTPXYZ is a drop-in replacement, all APIs, exceptions, and behaviour are identical.
If you want to use HTTPXYZ natively:
import httpxyz
r = httpxyz.get("https://www.example.org/")
Transparent httpx aliasing
Importing httpxyz automatically registers itself as sys.modules["httpx"]. This means that any third-party library which does import httpx internally will receive httpxyz instead, as long as httpxyz was imported first:
import httpxyz # registers httpxyz as sys.modules["httpx"]
import some_library # internally does `import httpx` — gets httpxyz
isinstance checks against httpx classes will therefore pass for httpxyz objects, even in code you don't control. See HTTPX Compatibility for full details, including how to set this up correctly when using respx in pytest.
Using HTTPXYZ
Install HTTPXYZ using pip:
$ pip install httpxyz
Now, let's get started:
>>> import httpxyz
>>> r = httpxyz.get('https://www.example.org/')
>>> r
<Response [200 OK]>
>>> r.status_code
200
>>> r.headers['content-type']
'text/html; charset=UTF-8'
>>> r.text
'<!doctype html>\n<html>\n<head>\n<title>Example Domain</title>...'
Or, using the command-line client.
$ pip install 'httpxyz[cli]' # The command line client is an optional dependency.
Which now allows us to use HTTPXYZ directly from the command-line...
Sending a request...
Features
HTTPXYZ builds on the well-established usability of requests, and gives you:
- A broadly requests-compatible API.
- An integrated command-line client.
- HTTP/1.1 and HTTP/2 support.
- Standard synchronous interface, but with async support if you need it.
- Ability to make requests directly to WSGI applications or ASGI applications.
- Strict timeouts everywhere.
- 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
- Elegant Key/Value Cookies
- Automatic Decompression
- Automatic Content Decoding
- Unicode Response Bodies
- Multipart File Uploads
- HTTP(S) Proxy Support
- Connection Timeouts
- Streaming Downloads
- .netrc Support
- Chunked Requests
Installation
Install with pip:
$ pip install httpxyz
Or, to include the optional HTTP/2 support, use:
$ pip install httpxyz[http2]
HTTPXYZ requires Python 3.9+.
Documentation
Project documentation is available at https://httpxyz.org/.
For a run-through of all the basics, head over to the QuickStart.
For more advanced topics, see the Advanced Usage section, the async support section, or the HTTP/2 section.
The Developer Interface provides a comprehensive API reference.
To find out about tools that integrate with HTTPXYZ, see Third Party Packages.
Contribute
If you want to contribute with HTTPXYZ check out the Contributing Guide to learn how to start.
Dependencies
The HTTPXYZ project relies on these excellent libraries:
httpcore- The underlying transport implementation forhttpxyz.h11- HTTP/1.1 support.
certifi- SSL certificates.idna- Internationalized domain name support.sniffio- Async library autodetection.
As well as these optional installs:
h2- HTTP/2 support. (Optional, withhttpxyz[http2])socksio- SOCKS proxy support. (Optional, withhttpxyz[socks])rich- Rich terminal support. (Optional, withhttpxyz[cli])click- Command line client support. (Optional, withhttpxyz[cli])brotliorbrotlicffi- Decoding for "brotli" compressed responses. (Optional, withhttpxyz[brotli])zstandard- Decoding for "zstd" compressed responses. (Optional, withhttpxyz[zstd])
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.
HTTPXYZ is BSD licensed code.
Designed & crafted with care.
— 🦋 —
Release Information
Now using HTTPCoreXYZ instead of HTTPCore
httpxyz now depends on httpcorexyz (our fork of
httpcore) instead of upstream httpcore. This release also upgrades to
httpcorexyz 1.1.0,
which brings substantial async performance improvements (approximately 3.3x lower
latency on async GET requests) by using fast_acquire for anyio locks and semaphores.
See the httpcorexyz 1.1.0 release notes for full details. (#36)
Added
keep_method_for_redirectsoption onClientandAsyncClient: whenTrue, preserves the original HTTP method on 301/302 redirects instead of converting to GET. (#46)
Fixed
no_proxynow correctly handles IPv6 CIDR ranges using a newIPNetPatternclass for accurate IP range matching. (#47)- Mounted transports are now properly closed even when the main transport raises an exception. (#43)
ByteStreamnow implements a real async iterator, fixing compatibility with async consumers that rely on__aiter__. (#44)InvalidURLis no longer raised on a malformedLocationheader whenfollow_redirects=False; the response is returned as-is. (#40)- Passing
params=on a request no longer overwrites query parameters set on the client'sbase_url. (#39) HTTPStatusErrorcan now be pickled. (#31)- Fixed missing
| Nonetype annotation on theauthparameter in top-level convenience functions (get,post, etc.). (#27)
Docs
- Added a note that
AsyncClient()initialization blocks the event loop during SSL context setup. (#42)
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file httpxyz-0.31.0.tar.gz.
File metadata
- Download URL: httpxyz-0.31.0.tar.gz
- Upload date:
- Size: 149.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0b91d54dd900d87b46d24d6ec3a69b6c20c5e9d2b89a540771c172c7835bf717
|
|
| MD5 |
48fa607d12cbd3cf57a5eb364651f83e
|
|
| BLAKE2b-256 |
4c1746259b2f8fc4d898b2cd61f372d6bdcc7a4b0ecb12769258a5f2368b5043
|
File details
Details for the file httpxyz-0.31.0-py3-none-any.whl.
File metadata
- Download URL: httpxyz-0.31.0-py3-none-any.whl
- Upload date:
- Size: 77.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0f9d3490cebf8fc97e59c1bc264d6139c8c99f569da4779c3abff8b476df5b21
|
|
| MD5 |
176db5fc5bff3fe2f80322837d5af4f7
|
|
| BLAKE2b-256 |
3f0087868350bc747b1d48926dd73a793876a5acc33ec8014169c0feaeedaedf
|
