Skip to content

introduce http2_prior_knowledge option in httpx Client #1523

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
p1-alexandrevaney wants to merge 2 commits into from
Closed

introduce http2_prior_knowledge option in httpx Client #1523

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
75e0b2a
introduce http2_prior_knowledge option in httpx Client
p1-alexandrevaney Feb 8, 2021
b2be0cf
lint http2_prior_knowledge options
p1-alexandrevaney Mar 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion httpx/_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -559,6 +559,7 @@ def __init__(
verify: VerifyTypes = True,
cert: CertTypes = None,
http2: bool = False,
http2_prior_knowledge: bool = False,
proxies: ProxiesTypes = None,
mounts: typing.Mapping[str, httpcore.SyncHTTPTransport] = None,
timeout: TimeoutTypes = DEFAULT_TIMEOUT_CONFIG,
Expand All @@ -583,6 +584,9 @@ def __init__(
trust_env=trust_env,
)

if http2_prior_knowledge:
http2 = True

if http2:
try:
import h2 # noqa
Expand Down Expand Up @@ -1192,6 +1196,7 @@ def __init__(
verify: VerifyTypes = True,
cert: CertTypes = None,
http2: bool = False,
http2_prior_knowledge: bool = False,
proxies: ProxiesTypes = None,
mounts: typing.Mapping[str, httpcore.AsyncHTTPTransport] = None,
timeout: TimeoutTypes = DEFAULT_TIMEOUT_CONFIG,
Expand All @@ -1216,6 +1221,9 @@ def __init__(
trust_env=trust_env,
)

if http2_prior_knowledge:
http2 = True

if http2:
try:
import h2 # noqa
Expand All @@ -1239,6 +1247,7 @@ def __init__(
verify=verify,
cert=cert,
http2=http2,
http2_prior_knowledge=http2_prior_knowledge,
limits=limits,
transport=transport,
app=app,
Expand All @@ -1255,6 +1264,7 @@ def __init__(
verify=verify,
cert=cert,
http2=http2,
http2_prior_knowledge=http2_prior_knowledge,
limits=limits,
trust_env=trust_env,
)
Expand All @@ -1271,6 +1281,7 @@ def _init_transport(
verify: VerifyTypes = True,
cert: CertTypes = None,
http2: bool = False,
http2_prior_knowledge: bool = False,
limits: Limits = DEFAULT_LIMITS,
transport: httpcore.AsyncHTTPTransport = None,
app: typing.Callable = None,
Expand All @@ -1283,7 +1294,12 @@ def _init_transport(
return ASGITransport(app=app)

return AsyncHTTPTransport(
verify=verify, cert=cert, http2=http2, limits=limits, trust_env=trust_env
verify=verify,
cert=cert,
http2=http2,
http2_prior_knowledge=http2_prior_knowledge,
limits=limits,
trust_env=trust_env,
)

def _init_proxy_transport(
Expand All @@ -1292,13 +1308,15 @@ def _init_proxy_transport(
verify: VerifyTypes = True,
cert: CertTypes = None,
http2: bool = False,
http2_prior_knowledge: bool = False,
limits: Limits = DEFAULT_LIMITS,
trust_env: bool = True,
) -> httpcore.AsyncHTTPTransport:
return AsyncHTTPTransport(
verify=verify,
cert=cert,
http2=http2,
http2_prior_knowledge=http2_prior_knowledge,
limits=limits,
trust_env=trust_env,
proxy=proxy,
Expand Down
17 changes: 15 additions & 2 deletions httpx/_config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,14 @@ def create_ssl_context(
verify: VerifyTypes = True,
trust_env: bool = True,
http2: bool = False,
http2_prior_knowledge: bool = False,
) -> ssl.SSLContext:
return SSLConfig(
cert=cert, verify=verify, trust_env=trust_env, http2=http2
cert=cert,
verify=verify,
trust_env=trust_env,
http2=http2,
http2_prior_knowledge=http2_prior_knowledge,
).ssl_context


Expand All @@ -65,11 +70,13 @@ def __init__(
verify: VerifyTypes = True,
trust_env: bool = True,
http2: bool = False,
http2_prior_knowledge: bool = False,
):
self.cert = cert
self.verify = verify
self.trust_env = trust_env
self.http2 = http2
self.http2_prior_knowledge = http2_prior_knowledge
self.ssl_context = self.load_ssl_context()

def load_ssl_context(self) -> ssl.SSLContext:
Expand All @@ -79,6 +86,7 @@ def load_ssl_context(self) -> ssl.SSLContext:
f"cert={self.cert!r} "
f"trust_env={self.trust_env!r} "
f"http2={self.http2!r}"
f"http2_prior_knowledge={self.http2_prior_knowledge!r}"
)

if self.verify:
Expand Down Expand Up @@ -162,7 +170,12 @@ def _create_default_ssl_context(self) -> ssl.SSLContext:
context.set_ciphers(DEFAULT_CIPHERS)

if ssl.HAS_ALPN:
alpn_idents = ["http/1.1", "h2"] if self.http2 else ["http/1.1"]
if self.http2_prior_knowledge:
alpn_idents = ["h2"]
elif self.http2:
alpn_idents = ["http/1.1", "h2"]
else:
alpn_idents = ["http/1.1"]
context.set_alpn_protocols(alpn_idents)

if hasattr(context, "keylog_filename"): # pragma: nocover (Available in 3.8+)
Expand Down
10 changes: 9 additions & 1 deletion httpx/_transports/default.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ def __init__(
verify: VerifyTypes = True,
cert: CertTypes = None,
http2: bool = False,
http2_prior_knowledge: bool = False,
limits: Limits = DEFAULT_LIMITS,
trust_env: bool = True,
proxy: Proxy = None,
Expand All @@ -119,7 +120,13 @@ def __init__(
retries: int = 0,
backend: str = "auto",
) -> None:
ssl_context = create_ssl_context(verify=verify, cert=cert, trust_env=trust_env)
ssl_context = create_ssl_context(
verify=verify,
cert=cert,
trust_env=trust_env,
http2=http2,
http2_prior_knowledge=http2_prior_knowledge,
)

if proxy is None:
self._pool = httpcore.AsyncConnectionPool(
Expand All @@ -128,6 +135,7 @@ def __init__(
max_keepalive_connections=limits.max_keepalive_connections,
keepalive_expiry=limits.keepalive_expiry,
http2=http2,
http2_prior_knowledge=http2_prior_knowledge,
uds=uds,
local_address=local_address,
retries=retries,
Expand Down