You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
133 lines
4.1 KiB
133 lines
4.1 KiB
"""
|
|
sphinx.util.requests
|
|
~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Simple requests package loader
|
|
|
|
:copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
|
|
:license: BSD, see LICENSE for details.
|
|
"""
|
|
|
|
import sys
|
|
import warnings
|
|
from contextlib import contextmanager
|
|
from typing import Any, Generator, Union
|
|
from urllib.parse import urlsplit
|
|
|
|
import requests
|
|
|
|
import sphinx
|
|
from sphinx.config import Config
|
|
from sphinx.deprecation import RemovedInSphinx50Warning
|
|
|
|
try:
|
|
from requests.packages.urllib3.exceptions import SSLError
|
|
except ImportError:
|
|
# python-requests package in Debian jessie does not provide ``requests.packages.urllib3``.
|
|
# So try to import the exceptions from urllib3 package.
|
|
from urllib3.exceptions import SSLError # type: ignore
|
|
|
|
try:
|
|
from requests.packages.urllib3.exceptions import InsecureRequestWarning
|
|
except ImportError:
|
|
try:
|
|
# for Debian-jessie
|
|
from urllib3.exceptions import InsecureRequestWarning # type: ignore
|
|
except ImportError:
|
|
# for requests < 2.4.0
|
|
InsecureRequestWarning = None # type: ignore
|
|
|
|
|
|
useragent_header = [('User-Agent',
|
|
'Mozilla/5.0 (X11; Linux x86_64; rv:25.0) Gecko/20100101 Firefox/25.0')]
|
|
|
|
|
|
def is_ssl_error(exc: Exception) -> bool:
|
|
"""Check an exception is SSLError."""
|
|
warnings.warn(
|
|
"is_ssl_error() is outdated and likely returns incorrect results "
|
|
"for modern versions of Requests.",
|
|
RemovedInSphinx50Warning)
|
|
if isinstance(exc, SSLError):
|
|
return True
|
|
else:
|
|
args = getattr(exc, 'args', [])
|
|
if args and isinstance(args[0], SSLError):
|
|
return True
|
|
else:
|
|
return False
|
|
|
|
|
|
@contextmanager
|
|
def ignore_insecure_warning(**kwargs: Any) -> Generator[None, None, None]:
|
|
with warnings.catch_warnings():
|
|
if not kwargs.get('verify') and InsecureRequestWarning:
|
|
# ignore InsecureRequestWarning if verify=False
|
|
warnings.filterwarnings("ignore", category=InsecureRequestWarning)
|
|
yield
|
|
|
|
|
|
def _get_tls_cacert(url: str, config: Config) -> Union[str, bool]:
|
|
"""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.
|
|
"""
|
|
if not config.tls_verify:
|
|
return False
|
|
|
|
certs = getattr(config, 'tls_cacerts', None)
|
|
if not certs:
|
|
return True
|
|
elif isinstance(certs, (str, tuple)):
|
|
return certs # type: ignore
|
|
else:
|
|
hostname = urlsplit(url)[1]
|
|
if '@' in hostname:
|
|
hostname = hostname.split('@')[1]
|
|
|
|
return certs.get(hostname, True)
|
|
|
|
|
|
def _get_user_agent(config: Config) -> str:
|
|
if config.user_agent:
|
|
return config.user_agent
|
|
else:
|
|
return ' '.join([
|
|
'Sphinx/%s' % sphinx.__version__,
|
|
'requests/%s' % requests.__version__,
|
|
'python/%s' % '.'.join(map(str, sys.version_info[:3])),
|
|
])
|
|
|
|
|
|
def get(url: str, **kwargs: Any) -> requests.Response:
|
|
"""Sends a GET request like requests.get().
|
|
|
|
This sets up User-Agent header and TLS verification automatically."""
|
|
headers = kwargs.setdefault('headers', {})
|
|
config = kwargs.pop('config', None)
|
|
if config:
|
|
kwargs.setdefault('verify', _get_tls_cacert(url, config))
|
|
headers.setdefault('User-Agent', _get_user_agent(config))
|
|
else:
|
|
headers.setdefault('User-Agent', useragent_header[0][1])
|
|
|
|
with ignore_insecure_warning(**kwargs):
|
|
return requests.get(url, **kwargs)
|
|
|
|
|
|
def head(url: str, **kwargs: Any) -> requests.Response:
|
|
"""Sends a HEAD request like requests.head().
|
|
|
|
This sets up User-Agent header and TLS verification automatically."""
|
|
headers = kwargs.setdefault('headers', {})
|
|
config = kwargs.pop('config', None)
|
|
if config:
|
|
kwargs.setdefault('verify', _get_tls_cacert(url, config))
|
|
headers.setdefault('User-Agent', _get_user_agent(config))
|
|
else:
|
|
headers.setdefault('User-Agent', useragent_header[0][1])
|
|
|
|
with ignore_insecure_warning(**kwargs):
|
|
return requests.head(url, **kwargs)
|