method: str,
url: URLTypes,
*,
- params: QueryParamTypes = None,
- content: RequestContent = None,
- data: RequestData = None,
- files: RequestFiles = None,
- json: typing.Any = None,
- headers: HeaderTypes = None,
- cookies: CookieTypes = None,
- auth: AuthTypes = None,
- proxies: ProxiesTypes = None,
+ params: typing.Optional[QueryParamTypes] = None,
+ content: typing.Optional[RequestContent] = None,
+ data: typing.Optional[RequestData] = None,
+ files: typing.Optional[RequestFiles] = None,
+ json: typing.Optional[typing.Any] = None,
+ headers: typing.Optional[HeaderTypes] = None,
+ cookies: typing.Optional[CookieTypes] = None,
+ auth: typing.Optional[AuthTypes] = None,
+ proxies: typing.Optional[ProxiesTypes] = None,
timeout: TimeoutTypes = DEFAULT_TIMEOUT_CONFIG,
follow_redirects: bool = False,
verify: VerifyTypes = True,
- cert: CertTypes = None,
+ cert: typing.Optional[CertTypes] = None,
trust_env: bool = True,
) -> Response:
"""
method: str,
url: URLTypes,
*,
- params: QueryParamTypes = None,
- content: RequestContent = None,
- data: RequestData = None,
- files: RequestFiles = None,
- json: typing.Any = None,
- headers: HeaderTypes = None,
- cookies: CookieTypes = None,
- auth: AuthTypes = None,
- proxies: ProxiesTypes = None,
+ params: typing.Optional[QueryParamTypes] = None,
+ content: typing.Optional[RequestContent] = None,
+ data: typing.Optional[RequestData] = None,
+ files: typing.Optional[RequestFiles] = None,
+ json: typing.Optional[typing.Any] = None,
+ headers: typing.Optional[HeaderTypes] = None,
+ cookies: typing.Optional[CookieTypes] = None,
+ auth: typing.Optional[AuthTypes] = None,
+ proxies: typing.Optional[ProxiesTypes] = None,
timeout: TimeoutTypes = DEFAULT_TIMEOUT_CONFIG,
follow_redirects: bool = False,
verify: VerifyTypes = True,
- cert: CertTypes = None,
+ cert: typing.Optional[CertTypes] = None,
trust_env: bool = True,
) -> typing.Iterator[Response]:
"""
def get(
url: URLTypes,
*,
- params: QueryParamTypes = None,
- headers: HeaderTypes = None,
- cookies: CookieTypes = None,
- auth: AuthTypes = None,
- proxies: ProxiesTypes = None,
+ params: typing.Optional[QueryParamTypes] = None,
+ headers: typing.Optional[HeaderTypes] = None,
+ cookies: typing.Optional[CookieTypes] = None,
+ auth: typing.Optional[AuthTypes] = None,
+ proxies: typing.Optional[ProxiesTypes] = None,
follow_redirects: bool = False,
- cert: CertTypes = None,
+ cert: typing.Optional[CertTypes] = None,
verify: VerifyTypes = True,
timeout: TimeoutTypes = DEFAULT_TIMEOUT_CONFIG,
trust_env: bool = True,
def options(
url: URLTypes,
*,
- params: QueryParamTypes = None,
- headers: HeaderTypes = None,
- cookies: CookieTypes = None,
- auth: AuthTypes = None,
- proxies: ProxiesTypes = None,
+ params: typing.Optional[QueryParamTypes] = None,
+ headers: typing.Optional[HeaderTypes] = None,
+ cookies: typing.Optional[CookieTypes] = None,
+ auth: typing.Optional[AuthTypes] = None,
+ proxies: typing.Optional[ProxiesTypes] = None,
follow_redirects: bool = False,
- cert: CertTypes = None,
+ cert: typing.Optional[CertTypes] = None,
verify: VerifyTypes = True,
timeout: TimeoutTypes = DEFAULT_TIMEOUT_CONFIG,
trust_env: bool = True,
def head(
url: URLTypes,
*,
- params: QueryParamTypes = None,
- headers: HeaderTypes = None,
- cookies: CookieTypes = None,
- auth: AuthTypes = None,
- proxies: ProxiesTypes = None,
+ params: typing.Optional[QueryParamTypes] = None,
+ headers: typing.Optional[HeaderTypes] = None,
+ cookies: typing.Optional[CookieTypes] = None,
+ auth: typing.Optional[AuthTypes] = None,
+ proxies: typing.Optional[ProxiesTypes] = None,
follow_redirects: bool = False,
- cert: CertTypes = None,
+ cert: typing.Optional[CertTypes] = None,
verify: VerifyTypes = True,
timeout: TimeoutTypes = DEFAULT_TIMEOUT_CONFIG,
trust_env: bool = True,
def post(
url: URLTypes,
*,
- content: RequestContent = None,
- data: RequestData = None,
- files: RequestFiles = None,
- json: typing.Any = None,
- params: QueryParamTypes = None,
- headers: HeaderTypes = None,
- cookies: CookieTypes = None,
- auth: AuthTypes = None,
- proxies: ProxiesTypes = None,
+ content: typing.Optional[RequestContent] = None,
+ data: typing.Optional[RequestData] = None,
+ files: typing.Optional[RequestFiles] = None,
+ json: typing.Optional[typing.Any] = None,
+ params: typing.Optional[QueryParamTypes] = None,
+ headers: typing.Optional[HeaderTypes] = None,
+ cookies: typing.Optional[CookieTypes] = None,
+ auth: typing.Optional[AuthTypes] = None,
+ proxies: typing.Optional[ProxiesTypes] = None,
follow_redirects: bool = False,
- cert: CertTypes = None,
+ cert: typing.Optional[CertTypes] = None,
verify: VerifyTypes = True,
timeout: TimeoutTypes = DEFAULT_TIMEOUT_CONFIG,
trust_env: bool = True,
def put(
url: URLTypes,
*,
- content: RequestContent = None,
- data: RequestData = None,
- files: RequestFiles = None,
- json: typing.Any = None,
- params: QueryParamTypes = None,
- headers: HeaderTypes = None,
- cookies: CookieTypes = None,
- auth: AuthTypes = None,
- proxies: ProxiesTypes = None,
+ content: typing.Optional[RequestContent] = None,
+ data: typing.Optional[RequestData] = None,
+ files: typing.Optional[RequestFiles] = None,
+ json: typing.Optional[typing.Any] = None,
+ params: typing.Optional[QueryParamTypes] = None,
+ headers: typing.Optional[HeaderTypes] = None,
+ cookies: typing.Optional[CookieTypes] = None,
+ auth: typing.Optional[AuthTypes] = None,
+ proxies: typing.Optional[ProxiesTypes] = None,
follow_redirects: bool = False,
- cert: CertTypes = None,
+ cert: typing.Optional[CertTypes] = None,
verify: VerifyTypes = True,
timeout: TimeoutTypes = DEFAULT_TIMEOUT_CONFIG,
trust_env: bool = True,
def patch(
url: URLTypes,
*,
- content: RequestContent = None,
- data: RequestData = None,
- files: RequestFiles = None,
- json: typing.Any = None,
- params: QueryParamTypes = None,
- headers: HeaderTypes = None,
- cookies: CookieTypes = None,
- auth: AuthTypes = None,
- proxies: ProxiesTypes = None,
+ content: typing.Optional[RequestContent] = None,
+ data: typing.Optional[RequestData] = None,
+ files: typing.Optional[RequestFiles] = None,
+ json: typing.Optional[typing.Any] = None,
+ params: typing.Optional[QueryParamTypes] = None,
+ headers: typing.Optional[HeaderTypes] = None,
+ cookies: typing.Optional[CookieTypes] = None,
+ auth: typing.Optional[AuthTypes] = None,
+ proxies: typing.Optional[ProxiesTypes] = None,
follow_redirects: bool = False,
- cert: CertTypes = None,
+ cert: typing.Optional[CertTypes] = None,
verify: VerifyTypes = True,
timeout: TimeoutTypes = DEFAULT_TIMEOUT_CONFIG,
trust_env: bool = True,
def delete(
url: URLTypes,
*,
- params: QueryParamTypes = None,
- headers: HeaderTypes = None,
- cookies: CookieTypes = None,
- auth: AuthTypes = None,
- proxies: ProxiesTypes = None,
+ params: typing.Optional[QueryParamTypes] = None,
+ headers: typing.Optional[HeaderTypes] = None,
+ cookies: typing.Optional[CookieTypes] = None,
+ auth: typing.Optional[AuthTypes] = None,
+ proxies: typing.Optional[ProxiesTypes] = None,
follow_redirects: bool = False,
- cert: CertTypes = None,
+ cert: typing.Optional[CertTypes] = None,
verify: VerifyTypes = True,
timeout: TimeoutTypes = DEFAULT_TIMEOUT_CONFIG,
trust_env: bool = True,
def __init__(
self,
*,
- auth: AuthTypes = None,
- params: QueryParamTypes = None,
- headers: HeaderTypes = None,
- cookies: CookieTypes = None,
+ auth: typing.Optional[AuthTypes] = None,
+ params: typing.Optional[QueryParamTypes] = None,
+ headers: typing.Optional[HeaderTypes] = None,
+ cookies: typing.Optional[CookieTypes] = None,
timeout: TimeoutTypes = DEFAULT_TIMEOUT_CONFIG,
follow_redirects: bool = False,
max_redirects: int = DEFAULT_MAX_REDIRECTS,
- event_hooks: typing.Mapping[str, typing.List[typing.Callable]] = None,
+ event_hooks: typing.Optional[
+ typing.Mapping[str, typing.List[typing.Callable]]
+ ] = None,
base_url: URLTypes = "",
trust_env: bool = True,
):
method: str,
url: URLTypes,
*,
- content: RequestContent = None,
- data: RequestData = None,
- files: RequestFiles = None,
- json: typing.Any = None,
- params: QueryParamTypes = None,
- headers: HeaderTypes = None,
- cookies: CookieTypes = None,
+ content: typing.Optional[RequestContent] = None,
+ data: typing.Optional[RequestData] = None,
+ files: typing.Optional[RequestFiles] = None,
+ json: typing.Optional[typing.Any] = None,
+ params: typing.Optional[QueryParamTypes] = None,
+ headers: typing.Optional[HeaderTypes] = None,
+ cookies: typing.Optional[CookieTypes] = None,
timeout: typing.Union[TimeoutTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
- extensions: dict = None,
+ extensions: typing.Optional[dict] = None,
) -> Request:
"""
Build and return a request instance.
return merge_url
def _merge_cookies(
- self, cookies: CookieTypes = None
+ self, cookies: typing.Optional[CookieTypes] = None
) -> typing.Optional[CookieTypes]:
"""
Merge a cookies argument together with any cookies on the client,
return cookies
def _merge_headers(
- self, headers: HeaderTypes = None
+ self, headers: typing.Optional[HeaderTypes] = None
) -> typing.Optional[HeaderTypes]:
"""
Merge a headers argument together with any headers on the client,
return merged_headers
def _merge_queryparams(
- self, params: QueryParamTypes = None
+ self, params: typing.Optional[QueryParamTypes] = None
) -> typing.Optional[QueryParamTypes]:
"""
Merge a queryparams argument together with any queryparams on the client,
return merged_queryparams.merge(params)
return params
- def _build_auth(self, auth: AuthTypes) -> typing.Optional[Auth]:
+ def _build_auth(self, auth: typing.Optional[AuthTypes]) -> typing.Optional[Auth]:
if auth is None:
return None
elif isinstance(auth, tuple):
def _build_request_auth(
self,
request: Request,
- auth: typing.Union[AuthTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
+ auth: typing.Union[AuthTypes, UseClientDefault, None] = USE_CLIENT_DEFAULT,
) -> Auth:
auth = (
self._auth if isinstance(auth, UseClientDefault) else self._build_auth(auth)
def __init__(
self,
*,
- auth: AuthTypes = None,
- params: QueryParamTypes = None,
- headers: HeaderTypes = None,
- cookies: CookieTypes = None,
+ auth: typing.Optional[AuthTypes] = None,
+ params: typing.Optional[QueryParamTypes] = None,
+ headers: typing.Optional[HeaderTypes] = None,
+ cookies: typing.Optional[CookieTypes] = None,
verify: VerifyTypes = True,
- cert: CertTypes = None,
+ cert: typing.Optional[CertTypes] = None,
http1: bool = True,
http2: bool = False,
- proxies: ProxiesTypes = None,
- mounts: typing.Mapping[str, BaseTransport] = None,
+ proxies: typing.Optional[ProxiesTypes] = None,
+ mounts: typing.Optional[typing.Mapping[str, BaseTransport]] = None,
timeout: TimeoutTypes = DEFAULT_TIMEOUT_CONFIG,
follow_redirects: bool = False,
limits: Limits = DEFAULT_LIMITS,
max_redirects: int = DEFAULT_MAX_REDIRECTS,
- event_hooks: typing.Mapping[str, typing.List[typing.Callable]] = None,
+ event_hooks: typing.Optional[
+ typing.Mapping[str, typing.List[typing.Callable]]
+ ] = None,
base_url: URLTypes = "",
- transport: BaseTransport = None,
- app: typing.Callable = None,
+ transport: typing.Optional[BaseTransport] = None,
+ app: typing.Optional[typing.Callable] = None,
trust_env: bool = True,
):
super().__init__(
def _init_transport(
self,
verify: VerifyTypes = True,
- cert: CertTypes = None,
+ cert: typing.Optional[CertTypes] = None,
http1: bool = True,
http2: bool = False,
limits: Limits = DEFAULT_LIMITS,
- transport: BaseTransport = None,
- app: typing.Callable = None,
+ transport: typing.Optional[BaseTransport] = None,
+ app: typing.Optional[typing.Callable] = None,
trust_env: bool = True,
) -> BaseTransport:
if transport is not None:
self,
proxy: Proxy,
verify: VerifyTypes = True,
- cert: CertTypes = None,
+ cert: typing.Optional[CertTypes] = None,
http1: bool = True,
http2: bool = False,
limits: Limits = DEFAULT_LIMITS,
method: str,
url: URLTypes,
*,
- content: RequestContent = None,
- data: RequestData = None,
- files: RequestFiles = None,
- json: typing.Any = None,
- params: QueryParamTypes = None,
- headers: HeaderTypes = None,
- cookies: CookieTypes = None,
- auth: typing.Union[AuthTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
+ content: typing.Optional[RequestContent] = None,
+ data: typing.Optional[RequestData] = None,
+ files: typing.Optional[RequestFiles] = None,
+ json: typing.Optional[typing.Any] = None,
+ params: typing.Optional[QueryParamTypes] = None,
+ headers: typing.Optional[HeaderTypes] = None,
+ cookies: typing.Optional[CookieTypes] = None,
+ auth: typing.Union[AuthTypes, UseClientDefault, None] = USE_CLIENT_DEFAULT,
follow_redirects: typing.Union[bool, UseClientDefault] = USE_CLIENT_DEFAULT,
timeout: typing.Union[TimeoutTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
- extensions: dict = None,
+ extensions: typing.Optional[dict] = None,
) -> Response:
"""
Build and send a request.
method: str,
url: URLTypes,
*,
- content: RequestContent = None,
- data: RequestData = None,
- files: RequestFiles = None,
- json: typing.Any = None,
- params: QueryParamTypes = None,
- headers: HeaderTypes = None,
- cookies: CookieTypes = None,
- auth: typing.Union[AuthTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
+ content: typing.Optional[RequestContent] = None,
+ data: typing.Optional[RequestData] = None,
+ files: typing.Optional[RequestFiles] = None,
+ json: typing.Optional[typing.Any] = None,
+ params: typing.Optional[QueryParamTypes] = None,
+ headers: typing.Optional[HeaderTypes] = None,
+ cookies: typing.Optional[CookieTypes] = None,
+ auth: typing.Union[AuthTypes, UseClientDefault, None] = USE_CLIENT_DEFAULT,
follow_redirects: typing.Union[bool, UseClientDefault] = USE_CLIENT_DEFAULT,
timeout: typing.Union[TimeoutTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
- extensions: dict = None,
+ extensions: typing.Optional[dict] = None,
) -> typing.Iterator[Response]:
"""
Alternative to `httpx.request()` that streams the response body
request: Request,
*,
stream: bool = False,
- auth: typing.Union[AuthTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
+ auth: typing.Union[AuthTypes, UseClientDefault, None] = USE_CLIENT_DEFAULT,
follow_redirects: typing.Union[bool, UseClientDefault] = USE_CLIENT_DEFAULT,
) -> Response:
"""
self,
url: URLTypes,
*,
- params: QueryParamTypes = None,
- headers: HeaderTypes = None,
- cookies: CookieTypes = None,
+ params: typing.Optional[QueryParamTypes] = None,
+ headers: typing.Optional[HeaderTypes] = None,
+ cookies: typing.Optional[CookieTypes] = None,
auth: typing.Union[AuthTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
follow_redirects: typing.Union[bool, UseClientDefault] = USE_CLIENT_DEFAULT,
timeout: typing.Union[TimeoutTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
- extensions: dict = None,
+ extensions: typing.Optional[dict] = None,
) -> Response:
"""
Send a `GET` request.
self,
url: URLTypes,
*,
- params: QueryParamTypes = None,
- headers: HeaderTypes = None,
- cookies: CookieTypes = None,
+ params: typing.Optional[QueryParamTypes] = None,
+ headers: typing.Optional[HeaderTypes] = None,
+ cookies: typing.Optional[CookieTypes] = None,
auth: typing.Union[AuthTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
follow_redirects: typing.Union[bool, UseClientDefault] = USE_CLIENT_DEFAULT,
timeout: typing.Union[TimeoutTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
- extensions: dict = None,
+ extensions: typing.Optional[dict] = None,
) -> Response:
"""
Send an `OPTIONS` request.
self,
url: URLTypes,
*,
- params: QueryParamTypes = None,
- headers: HeaderTypes = None,
- cookies: CookieTypes = None,
+ params: typing.Optional[QueryParamTypes] = None,
+ headers: typing.Optional[HeaderTypes] = None,
+ cookies: typing.Optional[CookieTypes] = None,
auth: typing.Union[AuthTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
follow_redirects: typing.Union[bool, UseClientDefault] = USE_CLIENT_DEFAULT,
timeout: typing.Union[TimeoutTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
- extensions: dict = None,
+ extensions: typing.Optional[dict] = None,
) -> Response:
"""
Send a `HEAD` request.
self,
url: URLTypes,
*,
- content: RequestContent = None,
- data: RequestData = None,
- files: RequestFiles = None,
- json: typing.Any = None,
- params: QueryParamTypes = None,
- headers: HeaderTypes = None,
- cookies: CookieTypes = None,
+ content: typing.Optional[RequestContent] = None,
+ data: typing.Optional[RequestData] = None,
+ files: typing.Optional[RequestFiles] = None,
+ json: typing.Optional[typing.Any] = None,
+ params: typing.Optional[QueryParamTypes] = None,
+ headers: typing.Optional[HeaderTypes] = None,
+ cookies: typing.Optional[CookieTypes] = None,
auth: typing.Union[AuthTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
follow_redirects: typing.Union[bool, UseClientDefault] = USE_CLIENT_DEFAULT,
timeout: typing.Union[TimeoutTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
- extensions: dict = None,
+ extensions: typing.Optional[dict] = None,
) -> Response:
"""
Send a `POST` request.
self,
url: URLTypes,
*,
- content: RequestContent = None,
- data: RequestData = None,
- files: RequestFiles = None,
- json: typing.Any = None,
- params: QueryParamTypes = None,
- headers: HeaderTypes = None,
- cookies: CookieTypes = None,
+ content: typing.Optional[RequestContent] = None,
+ data: typing.Optional[RequestData] = None,
+ files: typing.Optional[RequestFiles] = None,
+ json: typing.Optional[typing.Any] = None,
+ params: typing.Optional[QueryParamTypes] = None,
+ headers: typing.Optional[HeaderTypes] = None,
+ cookies: typing.Optional[CookieTypes] = None,
auth: typing.Union[AuthTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
follow_redirects: typing.Union[bool, UseClientDefault] = USE_CLIENT_DEFAULT,
timeout: typing.Union[TimeoutTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
- extensions: dict = None,
+ extensions: typing.Optional[dict] = None,
) -> Response:
"""
Send a `PUT` request.
self,
url: URLTypes,
*,
- content: RequestContent = None,
- data: RequestData = None,
- files: RequestFiles = None,
- json: typing.Any = None,
- params: QueryParamTypes = None,
- headers: HeaderTypes = None,
- cookies: CookieTypes = None,
+ content: typing.Optional[RequestContent] = None,
+ data: typing.Optional[RequestData] = None,
+ files: typing.Optional[RequestFiles] = None,
+ json: typing.Optional[typing.Any] = None,
+ params: typing.Optional[QueryParamTypes] = None,
+ headers: typing.Optional[HeaderTypes] = None,
+ cookies: typing.Optional[CookieTypes] = None,
auth: typing.Union[AuthTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
follow_redirects: typing.Union[bool, UseClientDefault] = USE_CLIENT_DEFAULT,
timeout: typing.Union[TimeoutTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
- extensions: dict = None,
+ extensions: typing.Optional[dict] = None,
) -> Response:
"""
Send a `PATCH` request.
self,
url: URLTypes,
*,
- params: QueryParamTypes = None,
- headers: HeaderTypes = None,
- cookies: CookieTypes = None,
+ params: typing.Optional[QueryParamTypes] = None,
+ headers: typing.Optional[HeaderTypes] = None,
+ cookies: typing.Optional[CookieTypes] = None,
auth: typing.Union[AuthTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
follow_redirects: typing.Union[bool, UseClientDefault] = USE_CLIENT_DEFAULT,
timeout: typing.Union[TimeoutTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
- extensions: dict = None,
+ extensions: typing.Optional[dict] = None,
) -> Response:
"""
Send a `DELETE` request.
def __exit__(
self,
- exc_type: typing.Type[BaseException] = None,
- exc_value: BaseException = None,
- traceback: TracebackType = None,
+ exc_type: typing.Optional[typing.Type[BaseException]] = None,
+ exc_value: typing.Optional[BaseException] = None,
+ traceback: typing.Optional[TracebackType] = None,
) -> None:
self._state = ClientState.CLOSED
def __init__(
self,
*,
- auth: AuthTypes = None,
- params: QueryParamTypes = None,
- headers: HeaderTypes = None,
- cookies: CookieTypes = None,
+ auth: typing.Optional[AuthTypes] = None,
+ params: typing.Optional[QueryParamTypes] = None,
+ headers: typing.Optional[HeaderTypes] = None,
+ cookies: typing.Optional[CookieTypes] = None,
verify: VerifyTypes = True,
- cert: CertTypes = None,
+ cert: typing.Optional[CertTypes] = None,
http1: bool = True,
http2: bool = False,
- proxies: ProxiesTypes = None,
- mounts: typing.Mapping[str, AsyncBaseTransport] = None,
+ proxies: typing.Optional[ProxiesTypes] = None,
+ mounts: typing.Optional[typing.Mapping[str, AsyncBaseTransport]] = None,
timeout: TimeoutTypes = DEFAULT_TIMEOUT_CONFIG,
follow_redirects: bool = False,
limits: Limits = DEFAULT_LIMITS,
max_redirects: int = DEFAULT_MAX_REDIRECTS,
- event_hooks: typing.Mapping[str, typing.List[typing.Callable]] = None,
+ event_hooks: typing.Optional[
+ typing.Mapping[str, typing.List[typing.Callable]]
+ ] = None,
base_url: URLTypes = "",
- transport: AsyncBaseTransport = None,
- app: typing.Callable = None,
+ transport: typing.Optional[AsyncBaseTransport] = None,
+ app: typing.Optional[typing.Callable] = None,
trust_env: bool = True,
):
super().__init__(
def _init_transport(
self,
verify: VerifyTypes = True,
- cert: CertTypes = None,
+ cert: typing.Optional[CertTypes] = None,
http1: bool = True,
http2: bool = False,
limits: Limits = DEFAULT_LIMITS,
- transport: AsyncBaseTransport = None,
- app: typing.Callable = None,
+ transport: typing.Optional[AsyncBaseTransport] = None,
+ app: typing.Optional[typing.Callable] = None,
trust_env: bool = True,
) -> AsyncBaseTransport:
if transport is not None:
self,
proxy: Proxy,
verify: VerifyTypes = True,
- cert: CertTypes = None,
+ cert: typing.Optional[CertTypes] = None,
http1: bool = True,
http2: bool = False,
limits: Limits = DEFAULT_LIMITS,
method: str,
url: URLTypes,
*,
- content: RequestContent = None,
- data: RequestData = None,
- files: RequestFiles = None,
- json: typing.Any = None,
- params: QueryParamTypes = None,
- headers: HeaderTypes = None,
- cookies: CookieTypes = None,
- auth: typing.Union[AuthTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
+ content: typing.Optional[RequestContent] = None,
+ data: typing.Optional[RequestData] = None,
+ files: typing.Optional[RequestFiles] = None,
+ json: typing.Optional[typing.Any] = None,
+ params: typing.Optional[QueryParamTypes] = None,
+ headers: typing.Optional[HeaderTypes] = None,
+ cookies: typing.Optional[CookieTypes] = None,
+ auth: typing.Union[AuthTypes, UseClientDefault, None] = USE_CLIENT_DEFAULT,
follow_redirects: typing.Union[bool, UseClientDefault] = USE_CLIENT_DEFAULT,
timeout: typing.Union[TimeoutTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
- extensions: dict = None,
+ extensions: typing.Optional[dict] = None,
) -> Response:
"""
Build and send a request.
method: str,
url: URLTypes,
*,
- content: RequestContent = None,
- data: RequestData = None,
- files: RequestFiles = None,
- json: typing.Any = None,
- params: QueryParamTypes = None,
- headers: HeaderTypes = None,
- cookies: CookieTypes = None,
+ content: typing.Optional[RequestContent] = None,
+ data: typing.Optional[RequestData] = None,
+ files: typing.Optional[RequestFiles] = None,
+ json: typing.Optional[typing.Any] = None,
+ params: typing.Optional[QueryParamTypes] = None,
+ headers: typing.Optional[HeaderTypes] = None,
+ cookies: typing.Optional[CookieTypes] = None,
auth: typing.Union[AuthTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
follow_redirects: typing.Union[bool, UseClientDefault] = USE_CLIENT_DEFAULT,
timeout: typing.Union[TimeoutTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
- extensions: dict = None,
+ extensions: typing.Optional[dict] = None,
) -> typing.AsyncIterator[Response]:
"""
Alternative to `httpx.request()` that streams the response body
request: Request,
*,
stream: bool = False,
- auth: typing.Union[AuthTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
+ auth: typing.Union[AuthTypes, UseClientDefault, None] = USE_CLIENT_DEFAULT,
follow_redirects: typing.Union[bool, UseClientDefault] = USE_CLIENT_DEFAULT,
) -> Response:
"""
self,
url: URLTypes,
*,
- params: QueryParamTypes = None,
- headers: HeaderTypes = None,
- cookies: CookieTypes = None,
- auth: typing.Union[AuthTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
+ params: typing.Optional[QueryParamTypes] = None,
+ headers: typing.Optional[HeaderTypes] = None,
+ cookies: typing.Optional[CookieTypes] = None,
+ auth: typing.Union[AuthTypes, UseClientDefault, None] = USE_CLIENT_DEFAULT,
follow_redirects: typing.Union[bool, UseClientDefault] = USE_CLIENT_DEFAULT,
timeout: typing.Union[TimeoutTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
- extensions: dict = None,
+ extensions: typing.Optional[dict] = None,
) -> Response:
"""
Send a `GET` request.
self,
url: URLTypes,
*,
- params: QueryParamTypes = None,
- headers: HeaderTypes = None,
- cookies: CookieTypes = None,
+ params: typing.Optional[QueryParamTypes] = None,
+ headers: typing.Optional[HeaderTypes] = None,
+ cookies: typing.Optional[CookieTypes] = None,
auth: typing.Union[AuthTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
follow_redirects: typing.Union[bool, UseClientDefault] = USE_CLIENT_DEFAULT,
timeout: typing.Union[TimeoutTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
- extensions: dict = None,
+ extensions: typing.Optional[dict] = None,
) -> Response:
"""
Send an `OPTIONS` request.
self,
url: URLTypes,
*,
- params: QueryParamTypes = None,
- headers: HeaderTypes = None,
- cookies: CookieTypes = None,
+ params: typing.Optional[QueryParamTypes] = None,
+ headers: typing.Optional[HeaderTypes] = None,
+ cookies: typing.Optional[CookieTypes] = None,
auth: typing.Union[AuthTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
follow_redirects: typing.Union[bool, UseClientDefault] = USE_CLIENT_DEFAULT,
timeout: typing.Union[TimeoutTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
- extensions: dict = None,
+ extensions: typing.Optional[dict] = None,
) -> Response:
"""
Send a `HEAD` request.
self,
url: URLTypes,
*,
- content: RequestContent = None,
- data: RequestData = None,
- files: RequestFiles = None,
- json: typing.Any = None,
- params: QueryParamTypes = None,
- headers: HeaderTypes = None,
- cookies: CookieTypes = None,
+ content: typing.Optional[RequestContent] = None,
+ data: typing.Optional[RequestData] = None,
+ files: typing.Optional[RequestFiles] = None,
+ json: typing.Optional[typing.Any] = None,
+ params: typing.Optional[QueryParamTypes] = None,
+ headers: typing.Optional[HeaderTypes] = None,
+ cookies: typing.Optional[CookieTypes] = None,
auth: typing.Union[AuthTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
follow_redirects: typing.Union[bool, UseClientDefault] = USE_CLIENT_DEFAULT,
timeout: typing.Union[TimeoutTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
- extensions: dict = None,
+ extensions: typing.Optional[dict] = None,
) -> Response:
"""
Send a `POST` request.
self,
url: URLTypes,
*,
- content: RequestContent = None,
- data: RequestData = None,
- files: RequestFiles = None,
- json: typing.Any = None,
- params: QueryParamTypes = None,
- headers: HeaderTypes = None,
- cookies: CookieTypes = None,
+ content: typing.Optional[RequestContent] = None,
+ data: typing.Optional[RequestData] = None,
+ files: typing.Optional[RequestFiles] = None,
+ json: typing.Optional[typing.Any] = None,
+ params: typing.Optional[QueryParamTypes] = None,
+ headers: typing.Optional[HeaderTypes] = None,
+ cookies: typing.Optional[CookieTypes] = None,
auth: typing.Union[AuthTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
follow_redirects: typing.Union[bool, UseClientDefault] = USE_CLIENT_DEFAULT,
timeout: typing.Union[TimeoutTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
- extensions: dict = None,
+ extensions: typing.Optional[dict] = None,
) -> Response:
"""
Send a `PUT` request.
self,
url: URLTypes,
*,
- content: RequestContent = None,
- data: RequestData = None,
- files: RequestFiles = None,
- json: typing.Any = None,
- params: QueryParamTypes = None,
- headers: HeaderTypes = None,
- cookies: CookieTypes = None,
+ content: typing.Optional[RequestContent] = None,
+ data: typing.Optional[RequestData] = None,
+ files: typing.Optional[RequestFiles] = None,
+ json: typing.Optional[typing.Any] = None,
+ params: typing.Optional[QueryParamTypes] = None,
+ headers: typing.Optional[HeaderTypes] = None,
+ cookies: typing.Optional[CookieTypes] = None,
auth: typing.Union[AuthTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
follow_redirects: typing.Union[bool, UseClientDefault] = USE_CLIENT_DEFAULT,
timeout: typing.Union[TimeoutTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
- extensions: dict = None,
+ extensions: typing.Optional[dict] = None,
) -> Response:
"""
Send a `PATCH` request.
self,
url: URLTypes,
*,
- params: QueryParamTypes = None,
- headers: HeaderTypes = None,
- cookies: CookieTypes = None,
+ params: typing.Optional[QueryParamTypes] = None,
+ headers: typing.Optional[HeaderTypes] = None,
+ cookies: typing.Optional[CookieTypes] = None,
auth: typing.Union[AuthTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
follow_redirects: typing.Union[bool, UseClientDefault] = USE_CLIENT_DEFAULT,
timeout: typing.Union[TimeoutTypes, UseClientDefault] = USE_CLIENT_DEFAULT,
- extensions: dict = None,
+ extensions: typing.Optional[dict] = None,
) -> Response:
"""
Send a `DELETE` request.
async def __aexit__(
self,
- exc_type: typing.Type[BaseException] = None,
- exc_value: BaseException = None,
- traceback: TracebackType = None,
+ exc_type: typing.Optional[typing.Type[BaseException]] = None,
+ exc_value: typing.Optional[BaseException] = None,
+ traceback: typing.Optional[TracebackType] = None,
) -> None:
self._state = ClientState.CLOSED
HTTP headers, as a case-insensitive multi-dict.
"""
- def __init__(self, headers: HeaderTypes = None, encoding: str = None) -> None:
+ def __init__(
+ self,
+ headers: typing.Optional[HeaderTypes] = None,
+ encoding: typing.Optional[str] = None,
+ ) -> None:
if headers is None:
self._list = [] # type: typing.List[typing.Tuple[bytes, bytes, bytes]]
elif isinstance(headers, Headers):
split_values.extend([item.strip() for item in value.split(",")])
return split_values
- def update(self, headers: HeaderTypes = None) -> None: # type: ignore
+ def update(self, headers: typing.Optional[HeaderTypes] = None) -> None: # type: ignore
headers = Headers(headers)
for key in headers.keys():
if key in self:
method: typing.Union[str, bytes],
url: typing.Union["URL", str, RawURL],
*,
- params: QueryParamTypes = None,
- headers: HeaderTypes = None,
- cookies: CookieTypes = None,
- content: RequestContent = None,
- data: RequestData = None,
- files: RequestFiles = None,
- json: typing.Any = None,
- stream: typing.Union[SyncByteStream, AsyncByteStream] = None,
- extensions: dict = None,
+ params: typing.Optional[QueryParamTypes] = None,
+ headers: typing.Optional[HeaderTypes] = None,
+ cookies: typing.Optional[CookieTypes] = None,
+ content: typing.Optional[RequestContent] = None,
+ data: typing.Optional[RequestData] = None,
+ files: typing.Optional[RequestFiles] = None,
+ json: typing.Optional[typing.Any] = None,
+ stream: typing.Union[SyncByteStream, AsyncByteStream, None] = None,
+ extensions: typing.Optional[dict] = None,
):
self.method = (
method.decode("ascii").upper()
self,
status_code: int,
*,
- headers: HeaderTypes = None,
- content: ResponseContent = None,
- text: str = None,
- html: str = None,
+ headers: typing.Optional[HeaderTypes] = None,
+ content: typing.Optional[ResponseContent] = None,
+ text: typing.Optional[str] = None,
+ html: typing.Optional[str] = None,
json: typing.Any = None,
- stream: typing.Union[SyncByteStream, AsyncByteStream] = None,
- request: Request = None,
- extensions: dict = None,
- history: typing.List["Response"] = None,
+ stream: typing.Union[SyncByteStream, AsyncByteStream, None] = None,
+ request: typing.Optional[Request] = None,
+ extensions: typing.Optional[dict] = None,
+ history: typing.Optional[typing.List["Response"]] = None,
):
self.status_code = status_code
self.headers = Headers(headers)
self._content = b"".join(self.iter_bytes())
return self._content
- def iter_bytes(self, chunk_size: int = None) -> typing.Iterator[bytes]:
+ def iter_bytes(
+ self, chunk_size: typing.Optional[int] = None
+ ) -> typing.Iterator[bytes]:
"""
A byte-iterator over the decoded response content.
This allows us to handle gzip, deflate, and brotli encoded responses.
for chunk in chunker.flush():
yield chunk
- def iter_text(self, chunk_size: int = None) -> typing.Iterator[str]:
+ def iter_text(
+ self, chunk_size: typing.Optional[int] = None
+ ) -> typing.Iterator[str]:
"""
A str-iterator over the decoded response content
that handles both gzip, deflate, etc but also detects the content's
for line in decoder.flush():
yield line
- def iter_raw(self, chunk_size: int = None) -> typing.Iterator[bytes]:
+ def iter_raw(
+ self, chunk_size: typing.Optional[int] = None
+ ) -> typing.Iterator[bytes]:
"""
A byte-iterator over the raw response content.
"""
self._content = b"".join([part async for part in self.aiter_bytes()])
return self._content
- async def aiter_bytes(self, chunk_size: int = None) -> typing.AsyncIterator[bytes]:
+ async def aiter_bytes(
+ self, chunk_size: typing.Optional[int] = None
+ ) -> typing.AsyncIterator[bytes]:
"""
A byte-iterator over the decoded response content.
This allows us to handle gzip, deflate, and brotli encoded responses.
for chunk in chunker.flush():
yield chunk
- async def aiter_text(self, chunk_size: int = None) -> typing.AsyncIterator[str]:
+ async def aiter_text(
+ self, chunk_size: typing.Optional[int] = None
+ ) -> typing.AsyncIterator[str]:
"""
A str-iterator over the decoded response content
that handles both gzip, deflate, etc but also detects the content's
for line in decoder.flush():
yield line
- async def aiter_raw(self, chunk_size: int = None) -> typing.AsyncIterator[bytes]:
+ async def aiter_raw(
+ self, chunk_size: typing.Optional[int] = None
+ ) -> typing.AsyncIterator[bytes]:
"""
A byte-iterator over the raw response content.
"""
HTTP Cookies, as a mutable mapping.
"""
- def __init__(self, cookies: CookieTypes = None) -> None:
+ def __init__(self, cookies: typing.Optional[CookieTypes] = None) -> None:
if cookies is None or isinstance(cookies, dict):
self.jar = CookieJar()
if isinstance(cookies, dict):
self.jar.set_cookie(cookie)
def get( # type: ignore
- self, name: str, default: str = None, domain: str = None, path: str = None
+ self,
+ name: str,
+ default: typing.Optional[str] = None,
+ domain: typing.Optional[str] = None,
+ path: typing.Optional[str] = None,
) -> typing.Optional[str]:
"""
Get a cookie by name. May optionally include domain and path
return default
return value
- def delete(self, name: str, domain: str = None, path: str = None) -> None:
+ def delete(
+ self,
+ name: str,
+ domain: typing.Optional[str] = None,
+ path: typing.Optional[str] = None,
+ ) -> None:
"""
Delete a cookie by name. May optionally include domain and path
in order to specify exactly which cookie to delete.
for cookie in remove:
self.jar.clear(cookie.domain, cookie.path, cookie.name)
- def clear(self, domain: str = None, path: str = None) -> None:
+ def clear(
+ self, domain: typing.Optional[str] = None, path: typing.Optional[str] = None
+ ) -> None:
"""
Delete all cookies. Optionally include a domain and path in
order to only delete a subset of all the cookies.
args.append(path)
self.jar.clear(*args)
- def update(self, cookies: CookieTypes = None) -> None: # type: ignore
+ def update(self, cookies: typing.Optional[CookieTypes] = None) -> None: # type: ignore
cookies = Cookies(cookies)
for cookie in cookies.jar:
self.jar.set_cookie(cookie)