sphinx.util.requests

module documentation
(source)

Simple requests package loader

Function get Sends a GET request like requests.get().
Function head Sends a HEAD request like requests.head().
Function ignore_insecure_warning Undocumented
Variable useragent_header Undocumented
Function _get_tls_cacert Get additional CA cert for a specific URL.
Function _get_user_agent Undocumented
def get(url, **kwargs): (source)

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): (source)

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): (source)

Undocumented

Parameters
**kwargs:AnyUndocumented
Returns
Generator[None, None, None]Undocumented
useragent_header: list = (source)

Undocumented

def _get_tls_cacert(url, config): (source)

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
str|boolUndocumented
def _get_user_agent(config): (source)

Undocumented

Parameters
config:ConfigUndocumented
Returns
strUndocumented