Adapt test_response_decode_text_using_autodetect for chardet 6.0 (#3773)

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

.github/workflows/test-suite.yml

@@ -18,12 +18,10 @@ jobs:
 
     steps:
       - uses: "actions/checkout@v4"
-      - name: Install uv (official Astral action)
+      - uses: "actions/setup-python@v6"
-        uses: astral-sh/setup-uv@v5
         with:
-          version: "0.9.13"
+          python-version: "${{ matrix.python-version }}"
-          enable-cache: true
+          allow-prereleases: true
-          python-version: ${{ matrix.python-version }}
       - name: "Install dependencies"
         run: "scripts/install"
       - name: "Run linting checks"

CHANGELOG.md

@@ -10,6 +10,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 * Drop support for Python 3.8
 
+### Added
+
+* Expose `FunctionAuth` from the public API. (#3699)
+
 ## 0.28.1 (6th December, 2024)
 
 * Fix SSL case where `verify=False` together with client side certificates.

docs/advanced/ssl.md

@@ -29,7 +29,7 @@ import certifi
 import httpx
 import ssl
 
-# This SSL context is equivelent to the default `verify=True`.
+# This SSL context is equivalent to the default `verify=True`.
 ctx = ssl.create_default_context(cafile=certifi.where())
 client = httpx.Client(verify=ctx)
 ```

httpx/__init__.py

@@ -50,6 +50,7 @@ __all__ = [
     "DecodingError",
     "delete",
     "DigestAuth",
+    "FunctionAuth",
     "get",
     "head",
     "Headers",

httpx/_auth.py

@@ -16,7 +16,7 @@ if typing.TYPE_CHECKING:  # pragma: no cover
     from hashlib import _Hash
 
 
-__all__ = ["Auth", "BasicAuth", "DigestAuth", "NetRCAuth"]
+__all__ = ["Auth", "BasicAuth", "DigestAuth", "FunctionAuth", "NetRCAuth"]
 
 
 class Auth:

pyproject.toml

@@ -64,40 +64,6 @@ Documentation = "https://www.python-httpx.org"
 Homepage = "https://github.com/encode/httpx"
 Source = "https://github.com/encode/httpx"
 
-[dependency-groups]
-dev = [
-    # Install httpx with all optional dependencies
-    { include-group = "test" },
-    { include-group = "docs" },
-    { include-group = "package" },
-    { include-group = "lint" },
-]
-test = [
-    # Optional charset auto-detection (used in test cases)
-    "chardet==5.2.0",
-    # Testing dependencies
-    "coverage[toml]==7.10.6",
-    "cryptography==45.0.7",
-    "pytest==8.4.1",
-    "trio==0.31.0",
-    "trio-typing==0.10.0",
-    "trustme==1.2.1",
-    "uvicorn==0.35.0",
-]
-docs = [
-    "mkdocs==1.6.1",
-    "mkautodoc==0.2.0",
-    "mkdocs-material==9.6.18",
-]
-package = [
-    "build==1.3.0",
-    "twine==6.1.0",
-]
-lint = [
-    "mypy==1.17.1",
-    "ruff==0.12.11",
-]
-
 [tool.hatch.version]
 path = "httpx/__version__.py"
 

requirements.txt

@@ -0,0 +1,29 @@
+# We're pinning our tooling, because it's an environment we can strictly control.
+# On the other hand, we're not pinning package dependencies, because our tests
+# needs to pass with the latest version of the packages.
+# Reference: https://github.com/encode/httpx/pull/1721#discussion_r661241588
+-e .[brotli,cli,http2,socks,zstd]
+
+# Optional charset auto-detection
+# Used in our test cases
+chardet==5.2.0
+
+# Documentation
+mkdocs==1.6.1
+mkautodoc==0.2.0
+mkdocs-material==9.6.18
+
+# Packaging
+build==1.3.0
+twine==6.1.0
+
+# Tests & Linting
+coverage[toml]==7.10.6
+cryptography==45.0.7
+mypy==1.17.1
+pytest==8.4.1
+ruff==0.12.11
+trio==0.31.0
+trio-typing==0.10.0
+trustme==1.2.1
+uvicorn==0.35.0

scripts/build

@@ -1,7 +1,13 @@
 #!/bin/sh -e
 
+if [ -d 'venv' ] ; then
+    PREFIX="venv/bin/"
+else
+    PREFIX=""
+fi
+
 set -x
 
-uv run python -m build
+${PREFIX}python -m build
-uv run twine check dist/*
+${PREFIX}twine check dist/*
-uv run mkdocs build
+${PREFIX}mkdocs build

scripts/check

@@ -1,16 +1,14 @@
 #!/bin/sh -e
 
+export PREFIX=""
+if [ -d 'venv' ] ; then
+    export PREFIX="venv/bin/"
+fi
 export SOURCE_FILES="httpx tests"
 
 set -x
 
 ./scripts/sync-version
-
+${PREFIX}ruff format $SOURCE_FILES --diff
-echo "==> Checking formatting…"
+${PREFIX}mypy $SOURCE_FILES
-uv run ruff format $SOURCE_FILES --diff
+${PREFIX}ruff check $SOURCE_FILES
-
-echo "==> Running type checks and linting…"
-uv run mypy $SOURCE_FILES
-
-echo "==> Running linting checks…"
-uv run ruff check $SOURCE_FILES

scripts/coverage

@@ -1,7 +1,11 @@
 #!/bin/sh -e
 
+export PREFIX=""
+if [ -d 'venv' ] ; then
+    export PREFIX="venv/bin/"
+fi
 export SOURCE_FILES="httpx tests"
 
 set -x
 
-uv run coverage report --show-missing --skip-covered --fail-under=100
+${PREFIX}coverage report --show-missing --skip-covered --fail-under=100

scripts/docs

@@ -1,5 +1,10 @@
 #!/bin/sh -e
 
+export PREFIX=""
+if [ -d 'venv' ] ; then
+    export PREFIX="venv/bin/"
+fi
+
 set -x
 
-uv run mkdocs serve
+${PREFIX}mkdocs serve

scripts/install

@@ -1,4 +1,19 @@
 #!/bin/sh -e
 
-echo "==> Installing Python dependencies…"
+# Use the Python executable provided from the `-p` option, or a default.
-uv sync --all-extras
+[ "$1" = "-p" ] && PYTHON=$2 || PYTHON="python3"
+
+REQUIREMENTS="requirements.txt"
+VENV="venv"
+
+set -x
+
+if [ -z "$GITHUB_ACTIONS" ]; then
+    "$PYTHON" -m venv "$VENV"
+    PIP="$VENV/bin/pip"
+else
+    PIP="pip"
+fi
+
+"$PIP" install -U pip
+"$PIP" install -r "$REQUIREMENTS"

scripts/lint

@@ -1,11 +1,12 @@
 #!/bin/sh -e
 
+export PREFIX=""
+if [ -d 'venv' ]; then
+    export PREFIX="venv/bin/"
+fi
 export SOURCE_FILES="httpx tests"
 
 set -x
 
-echo "==> Running linting checks…"
+${PREFIX}ruff check --fix $SOURCE_FILES
-uv run ruff check --fix $SOURCE_FILES
+${PREFIX}ruff format $SOURCE_FILES
-
-echo "==> Formatting source code…"
-uv run ruff format $SOURCE_FILES

scripts/publish

@@ -2,6 +2,11 @@
 
 VERSION_FILE="httpx/__version__.py"
 
+if [ -d 'venv' ] ; then
+    PREFIX="venv/bin/"
+else
+    PREFIX=""
+fi
 
 if [ ! -z "$GITHUB_ACTIONS" ]; then
   git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
@@ -17,5 +22,5 @@ fi
 
 set -x
 
-uv run twine upload dist/*
+${PREFIX}twine upload dist/*
-uv run mkdocs gh-deploy --force
+${PREFIX}mkdocs gh-deploy --force

scripts/test

@@ -1,12 +1,17 @@
 #!/bin/sh
 
+export PREFIX=""
+if [ -d 'venv' ] ; then
+    export PREFIX="venv/bin/"
+fi
+
 set -ex
 
 if [ -z $GITHUB_ACTIONS ]; then
     scripts/check
 fi
 
-uv run coverage run -m pytest "$@"
+${PREFIX}coverage run -m pytest "$@"
 
 if [ -z $GITHUB_ACTIONS ]; then
     scripts/coverage

tests/models/test_responses.py

@@ -1011,7 +1011,10 @@ def test_response_decode_text_using_autodetect():
 
     assert response.status_code == 200
     assert response.reason_phrase == "OK"
-    assert response.encoding == "ISO-8859-1"
+    # The encoded byte string is consistent with either ISO-8859-1 or
+    # WINDOWS-1252. Versions <6.0 of chardet claim the former, while chardet
+    # 6.0 detects the latter.
+    assert response.encoding in ("ISO-8859-1", "WINDOWS-1252")
     assert response.text == text