a
ljS @ s d dl mZ d dlZd dlZd dlZd dlZd dlZd dlmZ d dl m
Z
ddl m Z m
Z
mZmZmZmZmZ ddlmZ eeZedg d Ze ZG d
d d eZ e e G d d
d
eZ e de _ dS ) )absolute_importN)
namedtuple) takewhile )ConnectTimeoutError
InvalidHeader
MaxRetryError
ProtocolError
ProxyErrorReadTimeoutError
ResponseError)sixRequestHistory)methodurlerrorstatusredirect_locationc @ s@ e Zd Zedd Zejdd Zedd Zejdd ZdS )
_RetryMetac C s t dt | jS Nz}Using 'Retry.DEFAULT_METHOD_WHITELIST' is deprecated and will be removed in v2.0. Use 'Retry.DEFAULT_ALLOWED_METHODS' insteadwarningswarnDeprecationWarningDEFAULT_ALLOWED_METHODScls r B/usr/lib/python3.9/site-packages/pip/_vendor/urllib3/util/retry.pyDEFAULT_METHOD_WHITELIST$ s
z#_RetryMeta.DEFAULT_METHOD_WHITELISTc C s t dt || _d S r r r valuer r r r - s
c C s t dt | jS NzUsing 'Retry.DEFAULT_REDIRECT_HEADERS_BLACKLIST' is deprecated and will be removed in v2.0. Use 'Retry.DEFAULT_REMOVE_HEADERS_ON_REDIRECT' insteadr r r "DEFAULT_REMOVE_HEADERS_ON_REDIRECTr r r r "DEFAULT_REDIRECT_HEADERS_BLACKLIST6 s
z-_RetryMeta.DEFAULT_REDIRECT_HEADERS_BLACKLISTc C s t dt || _d S r" r# r r r r r% ? s
N)__name__
__module__ __qualname__propertyr setterr% r r r r r # s
r c s e Zd ZdZeg dZeg dZedgZdZdddddde ddd d dd e e fd
d Z
d d
Z e d-ddZ
dd Zdd Zdd Zd.ddZdd Zd/ddZd d Zd d Zd d! Zd0d#d$Zd%d& Zd1d'd(Zd)d* Z fd+d,Z Z S )2RetryaB Retry configuration.
Each retry attempt will create a new Retry object with updated values, so
they can be safely reused.
Retries can be defined as a default for a pool::
retries = Retry(connect=5, read=2, redirect=5)
http = PoolManager(retries=retries)
response = http.request('GET', 'http://example.com/')
Or per-request (which overrides the default for the pool)::
response = http.request('GET', 'http://example.com/', retries=Retry(10))
Retries can be disabled by passing ``False``::
response = http.request('GET', 'http://example.com/', retries=False)
Errors will be wrapped in :class:`~urllib3.exceptions.MaxRetryError` unless
retries are disabled, in which case the causing exception will be raised.
:param int total:
Total number of retries to allow. Takes precedence over other counts.
Set to ``None`` to remove this constraint and fall back on other
counts.
Set to ``0`` to fail on the first retry.
Set to ``False`` to disable and imply ``raise_on_redirect=False``.
:param int connect:
How many connection-related errors to retry on.
These are errors raised before the request is sent to the remote server,
which we assume has not triggered the server to process the request.
Set to ``0`` to fail on the first retry of this type.
:param int read:
How many times to retry on read errors.
These errors are raised after the request was sent to the server, so the
request may have side-effects.
Set to ``0`` to fail on the first retry of this type.
:param int redirect:
How many redirects to perform. Limit this to avoid infinite redirect
loops.
A redirect is a HTTP response with a status code 301, 302, 303, 307 or
308.
Set to ``0`` to fail on the first retry of this type.
Set to ``False`` to disable and imply ``raise_on_redirect=False``.
:param int status:
How many times to retry on bad status codes.
These are retries made on responses, where status code matches
``status_forcelist``.
Set to ``0`` to fail on the first retry of this type.
:param int other:
How many times to retry on other errors.
Other errors are errors that are not connect, read, redirect or status errors.
These errors might be raised after the request was sent to the server, so the
request might have side-effects.
Set to ``0`` to fail on the first retry of this type.
If ``total`` is not set, it's a good idea to set this to 0 to account
for unexpected edge cases and avoid infinite retry loops.
:param iterable allowed_methods:
Set of uppercased HTTP method verbs that we should retry on.
By default, we only retry on methods which are considered to be
idempotent (multiple requests with the same parameters end with the
same state). See :attr:`Retry.DEFAULT_ALLOWED_METHODS`.
Set to a ``False`` value to retry on any verb.
.. warning::
Previously this parameter was named ``method_whitelist``, that
usage is deprecated in v1.26.0 and will be removed in v2.0.
:param iterable status_forcelist:
A set of integer HTTP status codes that we should force a retry on.
A retry is initiated if the request method is in ``allowed_methods``
and the response status code is in ``status_forcelist``.
By default, this is disabled with ``None``.
:param float backoff_factor:
A backoff factor to apply between attempts after the second try
(most errors are resolved immediately by a second try without a
delay). urllib3 will sleep for::
{backoff factor} * (2 ** ({number of total retries} - 1))
seconds. If the backoff_factor is 0.1, then :func:`.sleep` will sleep
for [0.0s, 0.2s, 0.4s, ...] between retries. It will never be longer
than :attr:`Retry.BACKOFF_MAX`.
By default, backoff is disabled (set to 0).
:param bool raise_on_redirect: Whether, if the number of redirects is
exhausted, to raise a MaxRetryError, or to return a response with a
response code in the 3xx range.
:param bool raise_on_status: Similar meaning to ``raise_on_redirect``:
whether we should raise an exception, or return a response,
if status falls in ``status_forcelist`` range and retries have
been exhausted.
:param tuple history: The history of the request encountered during
each call to :meth:`~Retry.increment`. The list is in the order
the requests occurred. Each list item is of class :class:`RequestHistory`.
:param bool respect_retry_after_header:
Whether to respect Retry-After header on status codes defined as
:attr:`Retry.RETRY_AFTER_STATUS_CODES` or not.
:param iterable remove_headers_on_redirect:
Sequence of headers to remove from the request when a response
indicating a redirect is returned before firing off the redirected
request.
)ZHEADZGETZPUTZDELETEZOPTIONSZTRACE)i i i Z
Authorizationx
Nr Tc C s |t ur,|t urtdtjdtdd |}|t u r:| j}|t u rH| j}|| _|| _|| _ || _
|| _ |du sv|du r~d}d}
|| _ |pt
| _|| _| | _|
| _| | _| pt | _|
| _tdd |D | _d S ) NzoUsing both 'allowed_methods' and 'method_whitelist' together is not allowed. Instead only use 'allowed_methods'lUsing 'method_whitelist' with Retry is deprecated and will be removed in v2.0. Use 'allowed_methods' insteadr )
stacklevelFr c S s g | ] }| qS r )lower).0hr r r
z"Retry.__init__..)_Default
ValueErrorr r r r r$ totalconnectreadr otherredirectsetstatus_forcelistallowed_methodsbackoff_factorraise_on_redirectraise_on_statustuplehistoryrespect_retry_after_header frozensetremove_headers_on_redirect)selfr7 r8 r9 r; r r: r> r= r? r@ rA rC rD rF method_whitelistr r r __init__ sD zRetry.__init__c K s t | j| j| j| j| j| j| j| j| j | j
| j | j | j
d
}d|vrxd|vrxd| jv rntdt | j|d< n
| j|d< || t| f i |S )N)
r7 r8 r9 r; r r: r= r? r@ rA rC rF rD rH r> r. )dictr7 r8 r9 r; r r: r= r? r@ rA rC rF rD __dict__r r r r> updatetype)rG kwparamsr r r new s2
z Retry.newc C sR |du r|dur|n| j }t|tr(|S t|o2d}| ||d}td|| |S )z3Backwards-compatibility for the old retries format.N)r; z!Converted retries value: %r -> %r)DEFAULT
isinstancer+ boollogdebug)r Zretriesr; defaultZ new_retriesr r r from_intB s
zRetry.from_intc C sF t ttdd t| j}|dkr(dS | jd|d }t| j|S )zIFormula for computing the current backoff
:rtype: float
c S s
| j d u S )N)r )xr r r X r4 z(Retry.get_backoff_time.. r r )lenlistr reversedrC r? min BACKOFF_MAX)rG Zconsecutive_errors_lenZ
backoff_valuer r r get_backoff_timeP s zRetry.get_backoff_timec C s t d|rt|}n`tj|}|d u r6td| |d d u r^|d d d |dd }tj|}|t }|dk rd}|S )Nz^\s*[0-9]+\s*$z Invalid Retry-After header: %s )r r- r ) rematchintemailZutilsZ parsedate_tzr Z mktime_tztime)rG retry_afterZsecondsZretry_date_tupleZ
retry_dater r r parse_retry_aftera s
zRetry.parse_retry_afterc C s | d}|du rdS | |S )z(Get the value of Retry-After in seconds.z Retry-AfterN)Z getheaderrh rG responserg r r r get_retry_afterx s
zRetry.get_retry_afterc C s | |}|r t| dS dS )NTF)rk rf sleepri r r r sleep_for_retry s
zRetry.sleep_for_retryc C s" | }|dkrd S t| d S )Nr )r` rf rl )rG Zbackoffr r r _sleep_backoff s zRetry._sleep_backoffc C s( | j r |r | |}|r dS | dS )aB Sleep between retry attempts.
This method will respect a server's ``Retry-After`` response header
and sleep the duration of the time requested. If that is not present, it
will use an exponential backoff. By default, the backoff factor is 0 and
this method will return immediately.
N)rD rm rn )rG rj Zsleptr r r rl s
z Retry.sleepc C s t |tr|j}t |tS )zzErrors when we're fairly sure that the server did not receive the
request, so it should be safe to retry.
)rR r
Zoriginal_errorr rG errr r r _is_connection_error s
zRetry._is_connection_errorc C s t |ttfS )zErrors that occur after the request has been started, so we should
assume that the server began processing it.
)rR r r ro r r r _is_read_error s zRetry._is_read_errorc C s< d| j v r tdt | j}n| j}|r8| |vr8dS dS )zyChecks if a given HTTP method should be retried upon, depending if
it is included in the allowed_methods
rH r. FT)rK r r r rH r> upper)rG r r> r r r _is_method_retryable s
zRetry._is_method_retryableFc C s< | |sdS | jr"|| jv r"dS | jo:| jo:|o:|| jv S )aw Is this method/status code retryable? (Based on allowlists and control
variables such as the number of total retries to allow, whether to
respect the Retry-After header, whether this header is present, and
whether the returned status code is on the list of status codes to
be retried upon on the presence of the aforementioned header)
FT)rt r= r7 rD RETRY_AFTER_STATUS_CODES)rG r status_codeZhas_retry_afterr r r is_retry s
zRetry.is_retryc C s> | j | j| j| j| j| jf}ttd|}|s2dS t|dk S )zAre we out of retries?NFr ) r7 r8 r9 r; r r: r\ filterr^ )rG Z retry_countsr r r is_exhausted s zRetry.is_exhaustedc C s | j du r |r tt|||| j }|dur6|d8 }| j}| j} | j}
| j} | j} d}
d}d}|r| |r|du rtt|||n|dur|d8 }n|r|
|r| du s| |stt|||n| dur| d8 } n|r| dur| d8 } nr|r.| r.|
dur|
d8 }
d}
| }|j}n getattrsuperr+ AttributeError)rG item __class__r r __getattr__J s zRetry.__getattr__)TN)N)N)F)NNNNNN) r& r' r( __doc__rE r ru r$ r_ r5 rI rP classmethodrW r` rh rk rm rn rl rq rr rt rw ry r} r~ r
__classcell__r r r r r+ I s^
=$
^r+ ) Z
__future__r re Zloggingrb rf r collectionsr itertoolsr
exceptionsr r r r r
r r Zpackagesr
Z getLoggerr& rT r objectr5 rM r Z
add_metaclassr+ rQ r r r r s, $
&