Skip to main content

web_utils

Utility functions for web interactions.

Module​

Functions​

async_delete​

async def async_delete(    url: URLTypes,    *,    params: Optional[QueryParamTypes] = None,    headers: Optional[HeaderTypes] = None,    cookies: Optional[CookieTypes] = None,    auth: Union[AuthTypes, UseClientDefault] = <httpx._client.UseClientDefault object>,    follow_redirects: Union[bool, UseClientDefault] = <httpx._client.UseClientDefault object>,    timeout: Union[TimeoutTypes, UseClientDefault] = <httpx._client.UseClientDefault object>,    extensions: Optional[dict] = None,    do_not_retry_codes: Optional[Collection[int]] = None,) ‑> httpx.Response:

See httpx.delete() for more information.

async_get​

async def async_get(    url: URLTypes,    *,    params: Optional[QueryParamTypes] = None,    headers: Optional[HeaderTypes] = None,    cookies: Optional[CookieTypes] = None,    auth: Union[AuthTypes, UseClientDefault, None] = <httpx._client.UseClientDefault object>,    follow_redirects: Union[bool, UseClientDefault] = <httpx._client.UseClientDefault object>,    timeout: Union[TimeoutTypes, UseClientDefault] = <httpx._client.UseClientDefault object>,    extensions: Optional[dict] = None,    do_not_retry_codes: Optional[Collection[int]] = None,) ‑> httpx.Response:

See httpx.get() for more information.

async_head​

async def async_head(    url: URLTypes,    *,    params: Optional[QueryParamTypes] = None,    headers: Optional[HeaderTypes] = None,    cookies: Optional[CookieTypes] = None,    auth: Union[AuthTypes, UseClientDefault] = <httpx._client.UseClientDefault object>,    follow_redirects: Union[bool, UseClientDefault] = <httpx._client.UseClientDefault object>,    timeout: Union[TimeoutTypes, UseClientDefault] = <httpx._client.UseClientDefault object>,    extensions: Optional[dict] = None,    do_not_retry_codes: Optional[Collection[int]] = None,) ‑> httpx.Response:

See httpx.head() for more information.

async_options​

async def async_options(    url: URLTypes,    *,    params: Optional[QueryParamTypes] = None,    headers: Optional[HeaderTypes] = None,    cookies: Optional[CookieTypes] = None,    auth: Union[AuthTypes, UseClientDefault] = <httpx._client.UseClientDefault object>,    follow_redirects: Union[bool, UseClientDefault] = <httpx._client.UseClientDefault object>,    timeout: Union[TimeoutTypes, UseClientDefault] = <httpx._client.UseClientDefault object>,    extensions: Optional[dict] = None,    do_not_retry_codes: Optional[Collection[int]] = None,) ‑> httpx.Response:

See httpx.options() for more information.

async_patch​

async def async_patch(    url: URLTypes,    *,    content: Optional[RequestContent] = None,    data: Optional[RequestData] = None,    files: Optional[RequestFiles] = None,    json: Optional[Any] = None,    params: Optional[QueryParamTypes] = None,    headers: Optional[HeaderTypes] = None,    cookies: Optional[CookieTypes] = None,    auth: Union[AuthTypes, UseClientDefault] = <httpx._client.UseClientDefault object>,    follow_redirects: Union[bool, UseClientDefault] = <httpx._client.UseClientDefault object>,    timeout: Union[TimeoutTypes, UseClientDefault] = <httpx._client.UseClientDefault object>,    extensions: Optional[dict] = None,    do_not_retry_codes: Optional[Collection[int]] = None,) ‑> httpx.Response:

See httpx.patch() for more information.

async_post​

async def async_post(    url: URLTypes,    *,    content: Optional[RequestContent] = None,    data: Optional[RequestData] = None,    files: Optional[RequestFiles] = None,    json: Optional[Any] = None,    params: Optional[QueryParamTypes] = None,    headers: Optional[HeaderTypes] = None,    cookies: Optional[CookieTypes] = None,    auth: Union[AuthTypes, UseClientDefault] = <httpx._client.UseClientDefault object>,    follow_redirects: Union[bool, UseClientDefault] = <httpx._client.UseClientDefault object>,    timeout: Union[TimeoutTypes, UseClientDefault] = <httpx._client.UseClientDefault object>,    extensions: Optional[dict] = None,    do_not_retry_codes: Optional[Collection[int]] = None,) ‑> httpx.Response:

See httpx.post() for more information.

async_put​

async def async_put(    url: URLTypes,    *,    content: Optional[RequestContent] = None,    data: Optional[RequestData] = None,    files: Optional[RequestFiles] = None,    json: Optional[Any] = None,    params: Optional[QueryParamTypes] = None,    headers: Optional[HeaderTypes] = None,    cookies: Optional[CookieTypes] = None,    auth: Union[AuthTypes, UseClientDefault] = <httpx._client.UseClientDefault object>,    follow_redirects: Union[bool, UseClientDefault] = <httpx._client.UseClientDefault object>,    timeout: Union[TimeoutTypes, UseClientDefault] = <httpx._client.UseClientDefault object>,    extensions: Optional[dict] = None,    do_not_retry_codes: Optional[Collection[int]] = None,) ‑> httpx.Response:

See httpx.put() for more information.

async_request​

async def async_request(    method: str,    url: URLTypes,    *,    content: Optional[RequestContent] = None,    data: Optional[RequestData] = None,    files: Optional[RequestFiles] = None,    json: Optional[Any] = None,    params: Optional[QueryParamTypes] = None,    headers: Optional[HeaderTypes] = None,    cookies: Optional[CookieTypes] = None,    auth: Union[AuthTypes, UseClientDefault, None] = <httpx._client.UseClientDefault object>,    follow_redirects: Union[bool, UseClientDefault] = <httpx._client.UseClientDefault object>,    timeout: Union[TimeoutTypes, UseClientDefault] = <httpx._client.UseClientDefault object>,    extensions: Optional[dict] = None,    do_not_retry_codes: Optional[Collection[int]] = None,) ‑> httpx.Response:

See httpx.request() for more information.

delete​

def delete(url, **kwargs):

See requests.delete() for more details.

get​

def get(url, params=None, **kwargs):

See requests.get() for more details.

def head(url, **kwargs):

See requests.head() for more details.

obfuscate_security_token​

def obfuscate_security_token(text: str) ‑> str:

Obfuscate a security token in a string.

Replaces the value of a security token in a string with asterisks.

Arguments

  • text: The string to obfuscate.

Returns The obfuscated string.

patch​

def patch(url, data=None, **kwargs):

See requests.patch() for more details.

post​

def post(url, data=None, json=None, **kwargs):

See requests.post() for more details.

put​

def put(url, data=None, **kwargs):

See requests.put() for more details.

request​

def request(method, url, **kwargs):

See requests.request() for more details.