changelog

feat: add socket_options to Client and AsyncClient classes

Display proxy protocol scheme on error (#3571)

Add httpx-retries to third party packages docs (#3552)

Docs: Add `httpx.Proxy` to api.md (#3512)

Add `httpdbg` to third party packages. (#3327)

Co-authored-by: Kar Petrosyan <92274156+karpetrosyan@users.noreply.github.com>

fix typo (#3519)

Sharper CHANGELOG entry. (#3448)

Bump cryptography from 44.0.0 to 44.0.1 (#3499)

docs: Use `with` to open files in multipart examples (#3478)

Add support for Python 3.13 (#3460)

Version 0.28.1 (#3445)

Fix `verify=False`, `cert=...` case. (#3442)

Add test for request params behavior changes (#3364) (#3440)

Co-authored-by: Tom Christie <tom@tomchristie.com>

Bump the python-packages group with 11 updates (#3434)

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Marcelo Trylesinski <marcelotryle@gmail.com>

Updating deprecated docstring Client() class (#3426)

Version 0.28.0. (#3419)

Fix `extensions` type annotation. (#3380)

Error on verify as str. (#3418)

Handle empty zstd responses (#3412)

Update CHANGELOG.md, fix typo(s) (#3406)

Move utility functions from _utils.py to _client.py (#3389)

Avoid private imports in test cases. (#3403)

Import ssl on demand (#3401)

Graceful upgrade path for 0.28. (#3394)

Move remaining utility functions from _utils.py to _models.py  (#3387)

Move utility functions from _utils.py to _multipart.py (#3388)

Move normalize header functions from _utils.py to _models.py (#3382)

Cleanup `Request` method parameter. (#3378)

add socks5h proxy support (#3178)

Signed-off-by: bin liu <liubin0329@gmail.com>
Co-authored-by: Tom Christie <tom@tomchristie.com>

made dependencies on certifi and httpcore only load when required (#3377)

Co-authored-by: Tom Christie <tom@tomchristie.com>

Cleanup unneccessary test case (#3375)

Just use default `safe=...` characters for `urlescape` (#3376)

Update CHANGELOG.md (#3374)

Review urlescape percent-safe set, and use + behavior for form spaces. (#3373)

Review URL percent escaping sets, from whatwg. (#3371)

Update CHANGELOG.md (#3372)

Ensure JSON representation is compact. #3363 (#3367)

Co-authored-by: Tom Christie <tom@tomchristie.com>

Introduce new `SSLContext` API & escalate deprecations. (#3319)

Co-authored-by: Kar Petrosyan <92274156+karpetrosyan@users.noreply.github.com>
Co-authored-by: T-256 <132141463+T-256@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>

Concise URL instantiation. (#3364)

typo: Reading a response expose response text, not request text (#3359)

Bump the python-packages group with 5 updates (#3329)

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Add `httpx-ws` to third party packages. (#3325)

Co-authored-by: Tom Christie <tom@tomchristie.com>

Add `httpx-socks` to third party packages. (#3326)

Clarified error when header value is None (#3312)

Co-authored-by: Zanie Blue <contact@zanie.dev>

Enable TestSuite for PRs to version branches. (#3318)

Revert "Removed leading $ from cli code blocks" (#3192)

Co-authored-by: Kar Petrosyan <92274156+karpetrosyan@users.noreply.github.com>

Add speakeasy sponsorship (#3305)

Bump cryptography from 43.0.0 to 43.0.1 (#3295)

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bump the python-packages group across 1 directory with 8 updates (#3292)

Reintroduce `URLTypes`. (#3288)

Update CHANGELOG for 0.27.1 release date. (#3285)

Version 0.27.1 (#3275)

Improve InvalidURL error message. (#3250)

Bump the python-packages group across 1 directory with 8 updates (#3247)

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Tom Christie <tom@tomchristie.com>

Clean up URL signature. (#3245)

Update requirements.txt (#3246)

Add URL parsing tests from WHATWG (#3188)

Co-authored-by: Kar Petrosyan <92274156+karpetrosyan@users.noreply.github.com>

Update asgi.py docstring (#3210)

Co-authored-by: Tom Christie <tom@tomchristie.com>

Bump the python-packages group with 8 updates (#3213)

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Fast path returns for normalize_path cases (#3189)

Co-authored-by: Kar Petrosyan <92274156+karpetrosyan@users.noreply.github.com>

[fix] Use proxy ssl context consistently (#3175)

Co-authored-by: Kar Petrosyan <92274156+karpetrosyan@users.noreply.github.com>

Removed leading $ from cli code blocks (#3174)

Co-authored-by: Tom Christie <tom@tomchristie.com>

Resolve queryparam quoting (#3187)

Fix doc links for making requests directly to WSGI/ASGI apps (#3186)

Bump the python-packages group with 6 updates (#3185)

Docs: fix small typos in Extensions doc (#3138)

Co-authored-by: Tom Christie <tom@tomchristie.com>

Bump the python-packages group with 8 updates (#3156)

Update URL.__init__ signature (#3159)

Document 'target' extension (#3160)

Add support for zstd decoding (#3139)

This adds support for zstd decoding using the python package zstandard.
This is similar to how it is implemented in urllib3. I also chose the
optional installation option httpx[zstd] to mimic the same option in
urllib3.

zstd decoding is similar to brotli, but in benchmarks it is supposed to
be even faster. The zstd compression is described in RFC 8878.

See https://github.com/encode/httpx/discussions/1986

Co-authored-by: Kamil Monicz <kamil@monicz.dev>

Bump the python-packages group with 8 updates (#3129)

Bumps the python-packages group with 8 updates:

| Package | From | To |
| --- | --- | --- |
| [mkdocs-material](https://github.com/squidfunk/mkdocs-material) | `9.5.6` | `9.5.12` |
| [build](https://github.com/pypa/build) | `1.0.3` | `1.1.1` |
| [twine](https://github.com/pypa/twine) | `4.0.2` | `5.0.0` |
| [coverage[toml]](https://github.com/nedbat/coveragepy) | `7.4.1` | `7.4.3` |
| [cryptography](https://github.com/pyca/cryptography) | `42.0.4` | `42.0.5` |
| [pytest](https://github.com/pytest-dev/pytest) | `8.0.0` | `8.0.2` |
| [ruff](https://github.com/astral-sh/ruff) | `0.1.15` | `0.3.0` |
| [uvicorn](https://github.com/encode/uvicorn) | `0.27.0.post1` | `0.27.1` |

Updates `mkdocs-material` from 9.5.6 to 9.5.12
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.5.6...9.5.12)

Updates `build` from 1.0.3 to 1.1.1
- [Release notes](https://github.com/pypa/build/releases)
- [Changelog](https://github.com/pypa/build/blob/main/CHANGELOG.rst)
- [Commits](https://github.com/pypa/build/compare/1.0.3...1.1.1)

Updates `twine` from 4.0.2 to 5.0.0
- [Release notes](https://github.com/pypa/twine/releases)
- [Changelog](https://github.com/pypa/twine/blob/main/docs/changelog.rst)
- [Commits](https://github.com/pypa/twine/compare/4.0.2...5.0.0)

Updates `coverage[toml]` from 7.4.1 to 7.4.3
- [Release notes](https://github.com/nedbat/coveragepy/releases)
- [Changelog](https://github.com/nedbat/coveragepy/blob/master/CHANGES.rst)
- [Commits](https://github.com/nedbat/coveragepy/compare/7.4.1...7.4.3)

Updates `cryptography` from 42.0.4 to 42.0.5
- [Changelog](https://github.com/pyca/cryptography/blob/main/CHANGELOG.rst)
- [Commits](https://github.com/pyca/cryptography/compare/42.0.4...42.0.5)

Updates `pytest` from 8.0.0 to 8.0.2
- [Release notes](https://github.com/pytest-dev/pytest/releases)
- [Changelog](https://github.com/pytest-dev/pytest/blob/main/CHANGELOG.rst)
- [Commits](https://github.com/pytest-dev/pytest/compare/8.0.0...8.0.2)

Updates `ruff` from 0.1.15 to 0.3.0
- [Release notes](https://github.com/astral-sh/ruff/releases)
- [Changelog](https://github.com/astral-sh/ruff/blob/main/CHANGELOG.md)
- [Commits](https://github.com/astral-sh/ruff/compare/v0.1.15...v0.3.0)

Updates `uvicorn` from 0.27.0.post1 to 0.27.1
- [Release notes](https://github.com/encode/uvicorn/releases)
- [Changelog](https://github.com/encode/uvicorn/blob/master/CHANGELOG.md)
- [Commits](https://github.com/encode/uvicorn/compare/0.27.0.post1...0.27.1)

---
updated-dependencies:
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: python-packages
- dependency-name: build
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: python-packages
- dependency-name: twine
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: python-packages
- dependency-name: coverage[toml]
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: python-packages
- dependency-name: cryptography
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: python-packages
- dependency-name: pytest
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: python-packages
- dependency-name: ruff
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: python-packages
- dependency-name: uvicorn
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: python-packages
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Tom Christie <tom@tomchristie.com>

format (#3131)

Co-authored-by: T-256 <Tester@test.com>

Keep clients in sync (#3120)

Co-authored-by: Tom Christie <tom@tomchristie.com>

Delete `README_chinese.md` (#3122)

Discussed in https://github.com/encode/httpx/discussions/3024

Having translated versions for our users is friendly, but we're not doing this in a consistent way.

Fix broken links in docs/contributing.md and CHANGELOG.md (#3124)

Update /advanced/#<anchor> links -> /advanced/clients/#<anchor> (#3123)

Fix client.send() timeout new Request instance (#3116)

fix docs basic authentication typo (#3112)

Signed-off-by: akgnah <1024@setq.me>
Co-authored-by: Tom Christie <tom@tomchristie.com>

test `same_origin` via public api (#3062)

Co-authored-by: Tom Christie <tom@tomchristie.com>

test `is_https_redirect` via public api (#3064)

* test `is_https_redirect` via public api

* Update tests/test_utils.py

Use more permissible types in ASGIApp  (#3109)

* Use the type.MutableMapping instead of Dict

MutableMapping is a slightly more permissible type (allowing the previous Dict type) but matches up to Starlettes tpyes

* Update CHANGELOG.md

---------

Co-authored-by: Tom Christie <tom@tomchristie.com>

Define and expose the API from the same place (#3106)

* Tidy up imports

* Update tests/test_exported_members.py

---------

Co-authored-by: Tom Christie <tom@tomchristie.com>

Bump cryptography from 42.0.2 to 42.0.4 (#3107)

Bumps [cryptography](https://github.com/pyca/cryptography) from 42.0.2 to 42.0.4.
- [Changelog](https://github.com/pyca/cryptography/blob/main/CHANGELOG.rst)
- [Commits](https://github.com/pyca/cryptography/compare/42.0.2...42.0.4)

---
updated-dependencies:
- dependency-name: cryptography
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Version 0.27.0 (#3095)

* Version 0.27.0

* Update CHANGELOG.md (#3097)

wrong year I think? I'm new to github so idk if I'm doing this right

Co-authored-by: ReadyRainFor <119354484+ReadyRainFor@users.noreply.github.com>
* Update CHANGELOG.md

* Update CHANGELOG.md

---------

Co-authored-by: Rain <119354484+Rainkenstein@users.noreply.github.com>
Co-authored-by: ReadyRainFor <119354484+ReadyRainFor@users.noreply.github.com>

Improve 'Custom transports' docs (#3081)

Extensions docs (#3080)

* Deprecate app=... in favour of explicit WSGITransport/ASGITransport

* Linting

* Linting

* Update WSGITransport and ASGITransport docs

* Deprecate app

* Drop deprecation tests

* Add CHANGELOG

* Deprecate 'app=...' shortcut, rather than removing it.

* Update CHANGELOG

* Fix test_asgi.test_deprecated_shortcut

* Extensions docs

* Include 'extensions' in docs index

* Update docs/advanced/extensions.md

Co-authored-by: Kar Petrosyan <92274156+karpetrosyan@users.noreply.github.com>
---------

Co-authored-by: Kar Petrosyan <92274156+karpetrosyan@users.noreply.github.com>

Deprecate `app=...` in favor of explicit `WSGITransport`/`ASGITransport`. (#3050)

* Deprecate app=... in favour of explicit WSGITransport/ASGITransport

* Linting

* Linting

* Update WSGITransport and ASGITransport docs

* Deprecate app

* Drop deprecation tests

* Add CHANGELOG

* Deprecate 'app=...' shortcut, rather than removing it.

* Update CHANGELOG

* Fix test_asgi.test_deprecated_shortcut

Bump the python-packages group with 6 updates (#3077)

Bumps the python-packages group with 6 updates:

| Package | From | To |
| --- | --- | --- |
| [mkdocs-material](https://github.com/squidfunk/mkdocs-material) | `9.5.3` | `9.5.6` |
| [coverage[toml]](https://github.com/nedbat/coveragepy) | `7.4.0` | `7.4.1` |
| [cryptography](https://github.com/pyca/cryptography) | `41.0.7` | `42.0.2` |
| [pytest](https://github.com/pytest-dev/pytest) | `7.4.4` | `8.0.0` |
| [ruff](https://github.com/astral-sh/ruff) | `0.1.13` | `0.1.15` |
| [uvicorn](https://github.com/encode/uvicorn) | `0.25.0` | `0.27.0.post1` |

Updates `mkdocs-material` from 9.5.3 to 9.5.6
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.5.3...9.5.6)

Updates `coverage[toml]` from 7.4.0 to 7.4.1
- [Release notes](https://github.com/nedbat/coveragepy/releases)
- [Changelog](https://github.com/nedbat/coveragepy/blob/master/CHANGES.rst)
- [Commits](https://github.com/nedbat/coveragepy/compare/7.4.0...7.4.1)

Updates `cryptography` from 41.0.7 to 42.0.2
- [Changelog](https://github.com/pyca/cryptography/blob/main/CHANGELOG.rst)
- [Commits](https://github.com/pyca/cryptography/compare/41.0.7...42.0.2)

Updates `pytest` from 7.4.4 to 8.0.0
- [Release notes](https://github.com/pytest-dev/pytest/releases)
- [Changelog](https://github.com/pytest-dev/pytest/blob/main/CHANGELOG.rst)
- [Commits](https://github.com/pytest-dev/pytest/compare/7.4.4...8.0.0)

Updates `ruff` from 0.1.13 to 0.1.15
- [Release notes](https://github.com/astral-sh/ruff/releases)
- [Changelog](https://github.com/astral-sh/ruff/blob/main/CHANGELOG.md)
- [Commits](https://github.com/astral-sh/ruff/compare/v0.1.13...v0.1.15)

Updates `uvicorn` from 0.25.0 to 0.27.0.post1
- [Release notes](https://github.com/encode/uvicorn/releases)
- [Changelog](https://github.com/encode/uvicorn/blob/master/CHANGELOG.md)
- [Commits](https://github.com/encode/uvicorn/compare/0.25.0...0.27.0.post1)

---
updated-dependencies:
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: python-packages
- dependency-name: coverage[toml]
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: python-packages
- dependency-name: cryptography
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: python-packages
- dependency-name: pytest
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: python-packages
- dependency-name: ruff
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: python-packages
- dependency-name: uvicorn
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: python-packages
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Mention NO_PROXY environment variable on Advanced Usage page (#3066)

Co-authored-by: Kar Petrosyan <92274156+karpetrosyan@users.noreply.github.com>

Use `__future__.annotations` (#3068)

* Switch to new typing style

* lint

test `parse_header_links` via public api (#3061)

* test `parse_header_links` via public api

* add no-link test

* Update tests/test_utils.py

---------

Co-authored-by: Tom Christie <tom@tomchristie.com>

test `obfuscate_sensitive_headers` via public api (#3063)

Drop outdated section (#3057)

Adding an indent to fix wrong rendering in warning block (#3056)

Fix sections references (#3058)

Bump the python-packages group with 3 updates (#3055)

Bumps the python-packages group with 3 updates: [ruff](https://github.com/astral-sh/ruff), [trio](https://github.com/python-trio/trio) and [uvicorn](https://github.com/encode/uvicorn).

Updates `ruff` from 0.1.9 to 0.1.13
- [Release notes](https://github.com/astral-sh/ruff/releases)
- [Changelog](https://github.com/astral-sh/ruff/blob/main/CHANGELOG.md)
- [Commits](https://github.com/astral-sh/ruff/compare/v0.1.9...v0.1.13)

Updates `trio` from 0.22.2 to 0.24.0
- [Release notes](https://github.com/python-trio/trio/releases)
- [Commits](https://github.com/python-trio/trio/compare/v0.22.2...v0.24.0)

Updates `uvicorn` from 0.24.0.post1 to 0.25.0
- [Release notes](https://github.com/encode/uvicorn/releases)
- [Changelog](https://github.com/encode/uvicorn/blob/master/CHANGELOG.md)
- [Commits](https://github.com/encode/uvicorn/compare/0.24.0.post1...0.25.0)

---
updated-dependencies:
- dependency-name: ruff
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: python-packages
- dependency-name: trio
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: python-packages
- dependency-name: uvicorn
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: python-packages
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Tom Christie <tom@tomchristie.com>

Docs restructuring. (#3049)

* Tweak docs layout

* Move client docs into folder

* Add clients/authentication section

* Client authentication docs

* Fix authentication example

* SSL Context

* Timeouts

* Event hooks

* Proxies, Transports

* Text encodings

* Resource limits

* 'Clients' -> 'Advanced'

* 'Clients' -> 'Advanced'

* Add client docs

---------

Co-authored-by: Kar Petrosyan <92274156+karpetrosyan@users.noreply.github.com>

Group dependencies on dependabot updates (#3054)

Fix RFC 2069 mode digest authentication (#3045)

* Fix RFC 2069 mode digest authentication

* Update CHANGELOG.md