HttpxClientFactory

Bases: ClientFactory

An asynchronous HTTP client factory, with connection pooling, HTTP/2, redirects, cookie persistence, etc.

It can be shared between tasks.

Usage:

>>> factory = HttpxClientFactory()
>>> async with factory() as client:
>>>     response = await client.get('https://example.org')

Parameters:

• auth - (optional) An authentication class to use when sending requests.
• params - (optional) Query parameters to include in request URLs, as a string, dictionary, or sequence of two-tuples.
• headers - (optional) Dictionary of HTTP headers to include when sending requests.
• cookies - (optional) Dictionary of Cookie items to include when sending requests.
• verify - (optional) Either True to use an SSL context with the default CA bundle, False to disable verification, or an instance of ssl.SSLContext to use a custom context.
• http2 - (optional) A boolean indicating if HTTP/2 support should be enabled. Defaults to False.
• proxy - (optional) A proxy URL where all the traffic should be routed.
• timeout - (optional) The timeout configuration to use when sending requests.
• limits - (optional) The limits configuration to use.
• max_redirects - (optional) The maximum number of redirect responses that should be followed.
• base_url - (optional) A URL to use as the base when building request URLs.
• transport - (optional) A transport class to use for sending requests over the network.
• trust_env - (optional) Enables or disables usage of environment variables for configuration.
• default_encoding - (optional) The default encoding to use for decoding response text, if no charset information is included in a response Content-Type header. Set to a callable for automatic character set detection. Default: "utf-8".

 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

def __init__(
    self,
    *,
    auth: AuthTypes | None = None,
    params: QueryParamTypes | None = None,
    headers: HeaderTypes | None = None,
    cookies: CookieTypes | None = None,
    verify: ssl.SSLContext | str | bool = True,
    cert: CertTypes | None = None,
    http1: bool = True,
    http2: bool = False,
    proxy: ProxyTypes | None = None,
    mounts: None | (typing.Mapping[str, AsyncBaseTransport | None]) = None,
    timeout: TimeoutTypes = DEFAULT_TIMEOUT_CONFIG,
    follow_redirects: bool = False,
    limits: Limits = DEFAULT_LIMITS,
    max_redirects: int = DEFAULT_MAX_REDIRECTS,
    event_hooks: None | (typing.Mapping[str, list[EventHook]]) = None,
    base_url: URL | str = "",
    transport: AsyncBaseTransport | None = None,
    trust_env: bool = True,
    default_encoding: str | typing.Callable[[bytes], str] = "utf-8",
    **kwargs: typing.Any,
) -> None:
    self.options = {
        "auth": auth,
        "params": params,
        "headers": headers,
        "cookies": cookies,
        "verify": verify,
        "cert": cert,
        "http1": http1,
        "http2": http2,
        "proxy": proxy,
        "mounts": mounts,
        "timeout": timeout,
        "follow_redirects": follow_redirects,
        "limits": limits,
        "max_redirects": max_redirects,
        "event_hooks": event_hooks,
        "base_url": base_url,
        "transport": transport,
        "trust_env": trust_env,
        "default_encoding": default_encoding,
        **kwargs,
    }

options = {'auth': auth, 'params': params, 'headers': headers, 'cookies': cookies, 'verify': verify, 'cert': cert, 'http1': http1, 'http2': http2, 'proxy': proxy, 'mounts': mounts, 'timeout': timeout, 'follow_redirects': follow_redirects, 'limits': limits, 'max_redirects': max_redirects, 'event_hooks': event_hooks, 'base_url': base_url, 'transport': transport, 'trust_env': trust_env, 'default_encoding': default_encoding, None: kwargs}

make_sync()

122
123

def make_sync(self) -> Client:
    return Client(**self.options)