encode/httpx
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
1,026 Commits 24 Branches 88 Tags 21 MiB
Python 99.5%
Shell 0.5%
77193b2ab6
Go to file
Antonio Larrosa 77193b2ab6
Add a network pytest mark for tests that use the network (#1669) 
* Add a network pytest mark for tests that use the network

Sometimes it's useful to have the tests that use the network
marked so they can be skipped easily when we know the network
is not available.

This is useful for example on SUSE and openSUSE's build servers.
When building the httpx packages (actually, any package in the
distribution) the network is disabled so we can assure
reproducible builds (among other benefits). With this mark, it's
easier to skip tests that can not succeed.

* Add a better explanation for the network marker

Co-authored-by: Florimond Manca <15911462+florimondmanca@users.noreply.github.com>

Co-authored-by: Joe <nigelchiang@outlook.com>
Co-authored-by: Florimond Manca <15911462+florimondmanca@users.noreply.github.com>
Co-authored-by: Tom Christie <tom@tomchristie.com>
2021-08-13 14:13:43 +01:00
.github Test under Python 3.10b3 (#1707) 2021-06-22 13:25:19 +01:00
docs Use either brotli or brotlicffi. (#1618) 2021-08-13 11:52:45 +01:00
httpx Use either brotli or brotlicffi. (#1618) 2021-08-13 11:52:45 +01:00
scripts Allow passing additional pytest args to scripts/test (#1710) 2021-06-24 11:15:59 +01:00
tests Add a network pytest mark for tests that use the network (#1669) 2021-08-13 14:13:43 +01:00
.gitignore Drop RedirectLoop exception (#819) 2020-02-24 10:09:52 +00:00
CHANGELOG.md Version 0.18.2 (#1690) 2021-06-17 11:29:22 +01:00
LICENSE.md Fix up license whitespacing (#1563) 2021-04-09 13:08:34 +01:00
MANIFEST.in Ensure py.typed makes it into source distributions. (#441) 2019-10-04 14:46:57 -05:00
mkdocs.yml Refine project workflow (#1534) 2021-03-24 16:48:57 +00:00
README.md Use either brotli or brotlicffi. (#1618) 2021-08-13 11:52:45 +01:00
requirements.txt 👷 Add Python 3.10 beta to the CI (#1682) 2021-06-15 11:59:30 +01:00
setup.cfg Add a network pytest mark for tests that use the network (#1669) 2021-08-13 14:13:43 +01:00
setup.py Use either brotli or brotlicffi. (#1618) 2021-08-13 11:52:45 +01:00

README.md

HTTPX

HTTPX - A next-generation HTTP client for Python.

Test Suite Package version

HTTPX is a fully featured HTTP client for Python 3, which provides sync and async APIs, and support for both HTTP/1.1 and HTTP/2.

Note: HTTPX should be considered in beta. We believe we've got the public API to a stable point now, but would strongly recommend pinning your dependencies to the 0.18.* release, so that you're able to properly review API changes between package updates. A 1.0 release is expected to be issued sometime in 2021.

Let's get started...

>>> import httpx
>>> r = httpx.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 async API...

Use IPython or Python 3.8+ with python -m asyncio to try this code interactively.

>>> import httpx
>>> async with httpx.AsyncClient() as client:
...     r = await client.get('https://www.example.org/')
...
>>> r
<Response [200 OK]>

Features

HTTPX builds on the well-established usability of requests, and gives you:

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 httpx

Or, to include the optional HTTP/2 support, use:

$ pip install httpx[http2]

HTTPX requires Python 3.6+.

Documentation

Project documentation is available at https://www.python-httpx.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 HTTPX, see Third Party Packages.

Contribute

If you want to contribute with HTTPX check out the Contributing Guide to learn how to start.

Dependencies

The HTTPX project relies on these excellent libraries:

  • httpcore - The underlying transport implementation for httpx.
    • h11 - HTTP/1.1 support.
    • h2 - HTTP/2 support. (Optional)
  • certifi - SSL certificates.
  • charset_normalizer - Charset auto-detection.
  • rfc3986 - URL parsing & normalization.
    • idna - Internationalized domain name support.
  • sniffio - Async library autodetection.
  • async_generator - Backport support for contextlib.asynccontextmanager. (Only required for Python 3.6)
  • brotli or brotlicffi - 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.

— ⭐️ —

HTTPX is BSD licensed code. Designed & built in Brighton, England.