httpx CertTypes `keyfile` and `password` should be Optional

The Fix

Upgrade to version 0.17.1 or later.

Based on closed encode/httpx issue #1502 · PR/commit linked

Production note: Most teams hit this during upgrades or environment changes. Roll out with a canary and smoke critical endpoints (health, OpenAPI/docs) before 100%.

Open PR/Commit

@@ -51,7 +51,14 @@
 CookieTypes = Union["Cookies", CookieJar, Dict[str, str], List[Tuple[str, str]]]
 
-CertTypes = Union[str, Tuple[str, str], Tuple[str, str, str]]
+CertTypes = Union[
+    # certfile

fix.md

Option A — Upgrade to fixed release\nUpgrade to version 0.17.1 or later.\nWhen NOT to use: Do not use this fix if the application requires strict type enforcement for keyfile and password.\n\n

Why This Fix Works in Production

Trigger: `SSLContext.load_cert_chain` can take `None` as arguments values ([docs](https://docs.python.org/3/library/ssl.html#ssl.SSLContext.load_cert_chain)) so I guess…
Mechanism: The CertTypes definition did not allow None for keyfile and password parameters
Why the fix works: Makes the `keyfile` and `password` parameters in CertTypes optional, allowing them to accept None values. (first fixed release: 0.17.1).

Production impact:

If left unfixed, the same config can fail only in production (env differences), causing startup failures or partial feature outages.

Why This Breaks in Prod

The CertTypes definition did not allow None for keyfile and password parameters
Production symptom (often without a traceback): `SSLContext.load_cert_chain` can take `None` as arguments values ([docs](https://docs.python.org/3/library/ssl.html#ssl.SSLContext.load_cert_chain)) so I guess this:

Proof / Evidence

GitHub issue: #1502
Fix PR: https://github.com/encode/httpx/pull/1503
First fixed release: 0.17.1
Reproduced locally: No (not executed)
Last verified: 2026-02-09
Confidence: 0.85
Did this fix it?: Yes (upstream fix exists)
Own content ratio: 0.73

Discussion

High-signal excerpts from the issue thread (symptoms, repros, edge-cases).

Jump to Sources Open on GitHub

“Feel like a type definition like that would be more readable broken over multiple lines, so many square brackets!”

@johtso · 2021-03-09 · source

“Hi, Sounds legit, happy to review PRs towards that. :)”

@florimondmanca · 2021-03-09 · source

Failure Signature (Search String)

`SSLContext.load_cert_chain` can take `None` as arguments values ([docs](https://docs.python.org/3/library/ssl.html#ssl.SSLContext.load_cert_chain)) so I guess this:
Feel like a type definition like that would be more readable broken over multiple lines, so many square brackets!

Copy-friendly signature

signature.txt

Failure Signature
-----------------
`SSLContext.load_cert_chain` can take `None` as arguments values ([docs](https://docs.python.org/3/library/ssl.html#ssl.SSLContext.load_cert_chain)) so I guess this:
Feel like a type definition like that would be more readable broken over multiple lines, so many square brackets!

Error Message

Signature-only (no traceback captured)

error.txt

Error Message
-------------
`SSLContext.load_cert_chain` can take `None` as arguments values ([docs](https://docs.python.org/3/library/ssl.html#ssl.SSLContext.load_cert_chain)) so I guess this:
Feel like a type definition like that would be more readable broken over multiple lines, so many square brackets!

What Broke

Type errors occurred when passing None values for keyfile and password in production.

Why It Broke

The CertTypes definition did not allow None for keyfile and password parameters

Fix Options (Details)

Option A — Upgrade to fixed release Safe default (recommended)

Upgrade to version 0.17.1 or later.

When NOT to use: Do not use this fix if the application requires strict type enforcement for keyfile and password.

Use when you can deploy the upstream fix. It is usually lower-risk than long-lived workarounds.

Fix reference: https://github.com/encode/httpx/pull/1503

First fixed release: 0.17.1

Last verified: 2026-02-09. Validate in your environment.

When NOT to Use This Fix

Do not use this fix if the application requires strict type enforcement for keyfile and password.

Did This Fix Work in Your Case?

Quick signal helps us prioritize which fixes to verify and improve.

Prevention

Add a CI check that diffs key outputs after upgrades (OpenAPI schema snapshots, JSON payload shapes, CLI output).
Upgrade behind a canary and run integration tests against the canary before 100% rollout.
Add a TLS smoke test that performs a real handshake in CI (include CA bundle validation and hostname checks).
Alert on handshake failures by error string and endpoint to catch cert/CA changes quickly.

Version Compatibility Table

Version	Status
0.17.1	Fixed

Related Issues

No related fixes found.

Cluster: httpx:configuration-error All hubs All clusters

Related clusters: Data consistency Other Timeout

Sources

We don’t republish the full GitHub discussion text. Use the links above for context.

httpx CertTypes `keyfile` and `password` should be Optional types. (Fix)