-
Notifications
You must be signed in to change notification settings - Fork 307
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
42 changed files
with
4,181 additions
and
6,425 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,56 @@ | ||
""" | ||
Python HTTP library with thread-safe connection pooling, file post support, user friendly, and more | ||
""" | ||
from __future__ import absolute_import | ||
|
||
from __future__ import annotations | ||
|
||
# Set default logging handler to avoid "No handler found" warnings. | ||
import logging | ||
import typing | ||
import warnings | ||
from logging import NullHandler | ||
|
||
from . import exceptions | ||
from ._base_connection import _TYPE_BODY | ||
from ._collections import HTTPHeaderDict | ||
from ._version import __version__ | ||
from .connectionpool import HTTPConnectionPool, HTTPSConnectionPool, connection_from_url | ||
from .filepost import encode_multipart_formdata | ||
from .filepost import _TYPE_FIELDS, encode_multipart_formdata | ||
from .poolmanager import PoolManager, ProxyManager, proxy_from_url | ||
from .response import HTTPResponse | ||
from .response import BaseHTTPResponse, HTTPResponse | ||
from .util.request import make_headers | ||
from .util.retry import Retry | ||
from .util.timeout import Timeout | ||
from .util.url import get_host | ||
|
||
# Ensure that Python is compiled with OpenSSL 1.1.1+ | ||
# If the 'ssl' module isn't available at all that's | ||
# fine, we only care if the module is available. | ||
try: | ||
import ssl | ||
except ImportError: | ||
pass | ||
else: | ||
if not ssl.OPENSSL_VERSION.startswith("OpenSSL "): # Defensive: | ||
warnings.warn( | ||
"urllib3 v2 only supports OpenSSL 1.1.1+, currently " | ||
f"the 'ssl' module is compiled with {ssl.OPENSSL_VERSION!r}. " | ||
"See: https://github.com/urllib3/urllib3/issues/3020", | ||
exceptions.NotOpenSSLWarning, | ||
) | ||
elif ssl.OPENSSL_VERSION_INFO < (1, 1, 1): # Defensive: | ||
raise ImportError( | ||
"urllib3 v2 only supports OpenSSL 1.1.1+, currently " | ||
f"the 'ssl' module is compiled with {ssl.OPENSSL_VERSION!r}. " | ||
"See: https://github.com/urllib3/urllib3/issues/2168" | ||
) | ||
|
||
__author__ = "Andrey Petrov ([email protected])" | ||
__license__ = "MIT" | ||
__version__ = __version__ | ||
|
||
__all__ = ( | ||
"HTTPConnectionPool", | ||
"HTTPHeaderDict", | ||
"HTTPSConnectionPool", | ||
"PoolManager", | ||
"ProxyManager", | ||
|
@@ -35,15 +61,18 @@ | |
"connection_from_url", | ||
"disable_warnings", | ||
"encode_multipart_formdata", | ||
"get_host", | ||
"make_headers", | ||
"proxy_from_url", | ||
"request", | ||
"BaseHTTPResponse", | ||
) | ||
|
||
logging.getLogger(__name__).addHandler(NullHandler()) | ||
|
||
|
||
def add_stderr_logger(level=logging.DEBUG): | ||
def add_stderr_logger( | ||
level: int = logging.DEBUG, | ||
) -> logging.StreamHandler[typing.TextIO]: | ||
""" | ||
Helper for quickly adding a StreamHandler to the logger. Useful for | ||
debugging. | ||
|
@@ -70,16 +99,51 @@ def add_stderr_logger(level=logging.DEBUG): | |
# mechanisms to silence them. | ||
# SecurityWarning's always go off by default. | ||
warnings.simplefilter("always", exceptions.SecurityWarning, append=True) | ||
# SubjectAltNameWarning's should go off once per host | ||
warnings.simplefilter("default", exceptions.SubjectAltNameWarning, append=True) | ||
# InsecurePlatformWarning's don't vary between requests, so we keep it default. | ||
warnings.simplefilter("default", exceptions.InsecurePlatformWarning, append=True) | ||
# SNIMissingWarnings should go off only once. | ||
warnings.simplefilter("default", exceptions.SNIMissingWarning, append=True) | ||
|
||
|
||
def disable_warnings(category=exceptions.HTTPWarning): | ||
def disable_warnings(category: type[Warning] = exceptions.HTTPWarning) -> None: | ||
""" | ||
Helper for quickly disabling all urllib3 warnings. | ||
""" | ||
warnings.simplefilter("ignore", category) | ||
|
||
|
||
_DEFAULT_POOL = PoolManager() | ||
|
||
|
||
def request( | ||
method: str, | ||
url: str, | ||
*, | ||
body: _TYPE_BODY | None = None, | ||
fields: _TYPE_FIELDS | None = None, | ||
headers: typing.Mapping[str, str] | None = None, | ||
preload_content: bool | None = True, | ||
decode_content: bool | None = True, | ||
redirect: bool | None = True, | ||
retries: Retry | bool | int | None = None, | ||
timeout: Timeout | float | int | None = 3, | ||
json: typing.Any | None = None, | ||
) -> BaseHTTPResponse: | ||
""" | ||
A convenience, top-level request method. It uses a module-global ``PoolManager`` instance. | ||
Therefore, its side effects could be shared across dependencies relying on it. | ||
To avoid side effects create a new ``PoolManager`` instance and use it instead. | ||
The method does not accept low-level ``**urlopen_kw`` keyword arguments. | ||
""" | ||
|
||
return _DEFAULT_POOL.request( | ||
method, | ||
url, | ||
body=body, | ||
fields=fields, | ||
headers=headers, | ||
preload_content=preload_content, | ||
decode_content=decode_content, | ||
redirect=redirect, | ||
retries=retries, | ||
timeout=timeout, | ||
json=json, | ||
) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,172 @@ | ||
from __future__ import annotations | ||
|
||
import typing | ||
|
||
from .util.connection import _TYPE_SOCKET_OPTIONS | ||
from .util.timeout import _DEFAULT_TIMEOUT, _TYPE_TIMEOUT | ||
from .util.url import Url | ||
|
||
_TYPE_BODY = typing.Union[bytes, typing.IO[typing.Any], typing.Iterable[bytes], str] | ||
|
||
|
||
class ProxyConfig(typing.NamedTuple): | ||
ssl_context: ssl.SSLContext | None | ||
use_forwarding_for_https: bool | ||
assert_hostname: None | str | Literal[False] | ||
assert_fingerprint: str | None | ||
|
||
|
||
class _ResponseOptions(typing.NamedTuple): | ||
# TODO: Remove this in favor of a better | ||
# HTTP request/response lifecycle tracking. | ||
request_method: str | ||
request_url: str | ||
preload_content: bool | ||
decode_content: bool | ||
enforce_content_length: bool | ||
|
||
|
||
if typing.TYPE_CHECKING: | ||
import ssl | ||
from typing import Literal, Protocol | ||
|
||
from .response import BaseHTTPResponse | ||
|
||
class BaseHTTPConnection(Protocol): | ||
default_port: typing.ClassVar[int] | ||
default_socket_options: typing.ClassVar[_TYPE_SOCKET_OPTIONS] | ||
|
||
host: str | ||
port: int | ||
timeout: None | ( | ||
float | ||
) # Instance doesn't store _DEFAULT_TIMEOUT, must be resolved. | ||
blocksize: int | ||
source_address: tuple[str, int] | None | ||
socket_options: _TYPE_SOCKET_OPTIONS | None | ||
|
||
proxy: Url | None | ||
proxy_config: ProxyConfig | None | ||
|
||
is_verified: bool | ||
proxy_is_verified: bool | None | ||
|
||
def __init__( | ||
self, | ||
host: str, | ||
port: int | None = None, | ||
*, | ||
timeout: _TYPE_TIMEOUT = _DEFAULT_TIMEOUT, | ||
source_address: tuple[str, int] | None = None, | ||
blocksize: int = 8192, | ||
socket_options: _TYPE_SOCKET_OPTIONS | None = ..., | ||
proxy: Url | None = None, | ||
proxy_config: ProxyConfig | None = None, | ||
) -> None: | ||
... | ||
|
||
def set_tunnel( | ||
self, | ||
host: str, | ||
port: int | None = None, | ||
headers: typing.Mapping[str, str] | None = None, | ||
scheme: str = "http", | ||
) -> None: | ||
... | ||
|
||
def connect(self) -> None: | ||
... | ||
|
||
def request( | ||
self, | ||
method: str, | ||
url: str, | ||
body: _TYPE_BODY | None = None, | ||
headers: typing.Mapping[str, str] | None = None, | ||
# We know *at least* botocore is depending on the order of the | ||
# first 3 parameters so to be safe we only mark the later ones | ||
# as keyword-only to ensure we have space to extend. | ||
*, | ||
chunked: bool = False, | ||
preload_content: bool = True, | ||
decode_content: bool = True, | ||
enforce_content_length: bool = True, | ||
) -> None: | ||
... | ||
|
||
def getresponse(self) -> BaseHTTPResponse: | ||
... | ||
|
||
def close(self) -> None: | ||
... | ||
|
||
@property | ||
def is_closed(self) -> bool: | ||
"""Whether the connection either is brand new or has been previously closed. | ||
If this property is True then both ``is_connected`` and ``has_connected_to_proxy`` | ||
properties must be False. | ||
""" | ||
|
||
@property | ||
def is_connected(self) -> bool: | ||
"""Whether the connection is actively connected to any origin (proxy or target)""" | ||
|
||
@property | ||
def has_connected_to_proxy(self) -> bool: | ||
"""Whether the connection has successfully connected to its proxy. | ||
This returns False if no proxy is in use. Used to determine whether | ||
errors are coming from the proxy layer or from tunnelling to the target origin. | ||
""" | ||
|
||
class BaseHTTPSConnection(BaseHTTPConnection, Protocol): | ||
default_port: typing.ClassVar[int] | ||
default_socket_options: typing.ClassVar[_TYPE_SOCKET_OPTIONS] | ||
|
||
# Certificate verification methods | ||
cert_reqs: int | str | None | ||
assert_hostname: None | str | Literal[False] | ||
assert_fingerprint: str | None | ||
ssl_context: ssl.SSLContext | None | ||
|
||
# Trusted CAs | ||
ca_certs: str | None | ||
ca_cert_dir: str | None | ||
ca_cert_data: None | str | bytes | ||
|
||
# TLS version | ||
ssl_minimum_version: int | None | ||
ssl_maximum_version: int | None | ||
ssl_version: int | str | None # Deprecated | ||
|
||
# Client certificates | ||
cert_file: str | None | ||
key_file: str | None | ||
key_password: str | None | ||
|
||
def __init__( | ||
self, | ||
host: str, | ||
port: int | None = None, | ||
*, | ||
timeout: _TYPE_TIMEOUT = _DEFAULT_TIMEOUT, | ||
source_address: tuple[str, int] | None = None, | ||
blocksize: int = 16384, | ||
socket_options: _TYPE_SOCKET_OPTIONS | None = ..., | ||
proxy: Url | None = None, | ||
proxy_config: ProxyConfig | None = None, | ||
cert_reqs: int | str | None = None, | ||
assert_hostname: None | str | Literal[False] = None, | ||
assert_fingerprint: str | None = None, | ||
server_hostname: str | None = None, | ||
ssl_context: ssl.SSLContext | None = None, | ||
ca_certs: str | None = None, | ||
ca_cert_dir: str | None = None, | ||
ca_cert_data: None | str | bytes = None, | ||
ssl_minimum_version: int | None = None, | ||
ssl_maximum_version: int | None = None, | ||
ssl_version: int | str | None = None, # Deprecated | ||
cert_file: str | None = None, | ||
key_file: str | None = None, | ||
key_password: str | None = None, | ||
) -> None: | ||
... |
Oops, something went wrong.