mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
141 lines
4.1 KiB
Python
141 lines
4.1 KiB
Python
# -*- coding: utf-8 -*-
|
|
"""
|
|
sphinx.util.requests
|
|
~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Simple requests package loader
|
|
|
|
:copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
|
|
:license: BSD, see LICENSE for details.
|
|
"""
|
|
|
|
from __future__ import absolute_import
|
|
|
|
import warnings
|
|
from contextlib import contextmanager
|
|
from urllib.parse import urlsplit
|
|
|
|
import pkg_resources
|
|
import requests
|
|
|
|
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
|
|
|
|
try:
|
|
from requests.packages.urllib3.exceptions import InsecurePlatformWarning
|
|
except ImportError:
|
|
try:
|
|
# for Debian-jessie
|
|
from urllib3.exceptions import InsecurePlatformWarning # type: ignore
|
|
except ImportError:
|
|
# for requests < 2.4.0
|
|
InsecurePlatformWarning = None # type: ignore
|
|
|
|
# try to load requests[security] (but only if SSL is available)
|
|
try:
|
|
import ssl # NOQA
|
|
except ImportError:
|
|
pass
|
|
else:
|
|
try:
|
|
pkg_resources.require(['requests[security]'])
|
|
except (pkg_resources.DistributionNotFound,
|
|
pkg_resources.VersionConflict):
|
|
pass # ignored
|
|
|
|
if False:
|
|
# For type annotation
|
|
from typing import Any, Generator, Union # NOQA
|
|
from sphinx.config import Config # NOQA
|
|
|
|
useragent_header = [('User-Agent',
|
|
'Mozilla/5.0 (X11; Linux x86_64; rv:25.0) Gecko/20100101 Firefox/25.0')]
|
|
|
|
|
|
def is_ssl_error(exc):
|
|
# type: (Exception) -> bool
|
|
"""Check an exception is SSLError."""
|
|
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):
|
|
# type: (Any) -> Generator
|
|
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, config):
|
|
# type: (str, 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(url, **kwargs):
|
|
# type: (str, Any) -> requests.Response
|
|
"""Sends a GET request like requests.get().
|
|
|
|
This sets up User-Agent header and TLS verification automatically."""
|
|
kwargs.setdefault('headers', dict(useragent_header))
|
|
config = kwargs.pop('config', None)
|
|
if config:
|
|
kwargs.setdefault('verify', _get_tls_cacert(url, config))
|
|
|
|
with ignore_insecure_warning(**kwargs):
|
|
return requests.get(url, **kwargs)
|
|
|
|
|
|
def head(url, **kwargs):
|
|
# type: (str, Any) -> requests.Response
|
|
"""Sends a HEAD request like requests.head().
|
|
|
|
This sets up User-Agent header and TLS verification automatically."""
|
|
kwargs.setdefault('headers', dict(useragent_header))
|
|
config = kwargs.pop('config', None)
|
|
if config:
|
|
kwargs.setdefault('verify', _get_tls_cacert(url, config))
|
|
|
|
with ignore_insecure_warning(**kwargs):
|
|
return requests.get(url, **kwargs)
|