sphinx.util.requests

module documentation

Simple requests package loader

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Variable ​Insecure​Request​Warning Undocumented
Variable useragent​_header Undocumented
Function ​_get​_tls​_cacert Get additional CA cert for a specific URL.
Function ​_get​_user​_agent Undocumented
Function get Sends a GET request like requests.get().
Function head Sends a HEAD request like requests.head().
Function ignore​_insecure​_warning Undocumented
Function is​_ssl​_error Check an exception is SSLError.
InsecureRequestWarning =

Undocumented

useragent_header: list =

Undocumented

def _get_tls_cacert(url, config):

Get additional CA cert for a specific URL.

This also returns False if verification is disabled. And returns True if additional CA cert not found.

Parameters
url:strUndocumented
config:ConfigUndocumented
Returns
Union[str, bool]Undocumented
def _get_user_agent(config):

Undocumented

Parameters
config:ConfigUndocumented
Returns
strUndocumented
def get(url, **kwargs):

Sends a GET request like requests.get().

This sets up User-Agent header and TLS verification automatically.

Parameters
url:strUndocumented
**kwargs:AnyUndocumented
Returns
requests.ResponseUndocumented
def head(url, **kwargs):

Sends a HEAD request like requests.head().

This sets up User-Agent header and TLS verification automatically.

Parameters
url:strUndocumented
**kwargs:AnyUndocumented
Returns
requests.ResponseUndocumented
@contextmanager
def ignore_insecure_warning(**kwargs):

Undocumented

Parameters
**kwargs:AnyUndocumented
Returns
Generator[None, None, None]Undocumented
def is_ssl_error(exc):
Check an exception is SSLError.
Parameters
exc:ExceptionUndocumented
Returns
boolUndocumented