]> git.ipfire.org Git - thirdparty/httpx.git/commitdiff
Docs: Add `httpx.Proxy` to api.md (#3512)
authormv-python <matusvalo@users.noreply.github.com>
Wed, 5 Mar 2025 12:52:58 +0000 (13:52 +0100)
committerGitHub <noreply@github.com>
Wed, 5 Mar 2025 12:52:58 +0000 (12:52 +0000)
docs/api.md

index d01cc649bab2f3a32cfdae3915afcd00f3500699..f1bd50c993f417119bb9ae14fe60e6856a1a7f2a 100644 (file)
@@ -159,3 +159,18 @@ what gets sent over the wire.*
 * `def delete(name, [domain], [path])`
 * `def clear([domain], [path])`
 * *Standard mutable mapping interface*
+
+## `Proxy`
+
+*A configuration of the proxy server.*
+
+```pycon
+>>> proxy = Proxy("http://proxy.example.com:8030")
+>>> client = Client(proxy=proxy)
+```
+
+* `def __init__(url, [ssl_context], [auth], [headers])`
+* `.url` - **URL**
+* `.auth` - **tuple[str, str]**
+* `.headers` - **Headers**
+* `.ssl_context` - **SSLContext**