�`Wn( � @ s� d d l m Z d d l Z d d l Z d d l m Z m Z m Z m Z m Z d d l
m Z e j e
� Z Gd d � d e � Z e d � e _ d S) � )�absolute_importN� )�ConnectTimeoutError�
MaxRetryError�
ProtocolError�ReadTimeoutError�
ResponseError)�sixc @ s� e Z d Z d Z e d d d d d d g � Z d Z d d
d
d
e d
d d d d d
d �
Z d d � Z e d d
d d � � Z
d d � Z d d � Z d d � Z
d d � Z d d � Z d d � Z d
d
d
d
d
d
d d � Z d! d" � Z d
S)#�Retrya�
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. It's a good idea to set this to some sensibly-high value to
account for unexpected edge cases and avoid infinite retry loops.
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 iterable method_whitelist:
Set of uppercased HTTP method verbs that we should retry on.
By default, we only retry on methods which are considered to be
indempotent (multiple requests with the same parameters end with the
same state). See :attr:`Retry.DEFAULT_METHOD_WHITELIST`.
:param iterable status_forcelist:
A set of HTTP status codes that we should force a retry on.
By default, this is disabled with ``None``.
:param float backoff_factor:
A backoff factor to apply between attempts. 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.1s, 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.
ZHEAD�GET�PUTZDELETEZOPTIONSZTRACE�x �
Nr Tc C s� | | _ | | _ | | _ | d k s3 | d k r? d } d } | | _ | pT t � | _ | | _ | | _ | | _ | | _ |
| _
d S)NFr ) �total�connect�read�redirect�set�status_forcelist�method_whitelist�backoff_factor�raise_on_redirect�raise_on_status�_observed_errors) �selfr r r r r r r r r r � r � /retry.py�__init__v s zRetry.__init__c K s� t d | j d | j d | j d | j d | j d | j d | j d | j d | j d
| j
�
} | j | � t | � | � S) Nr r r r r r r r r r )
�dictr r r r r r r r r r �update�type)r �kwZparamsr r r �new� s
z Retry.newc C su | d k r' | d k r | n | j } t | t � r: | St | � oI d } | | d | �} t j d | | � | S)z4 Backwards-compatibility for the old retries format.Nr z!Converted retries value: %r -> %r)�DEFAULT�
isinstancer
�bool�log�debug)�clsZretriesr �defaultZ new_retriesr r r �from_int� s zRetry.from_intc C s; | j d k r d S| j d | j d } t | j | � S)zJ Formula for computing the current backoff
:rtype: float
� r r )r r �min� BACKOFF_MAX)r Z
backoff_valuer r r �get_backoff_time� s zRetry.get_backoff_timec C s- | j � } | d k r d St j | � d S)z� Sleep between retry attempts using an exponential backoff.
By default, the backoff factor is 0 and this method will return
immediately.
r N)r. �time�sleep)r Zbackoffr r r r0 � s z Retry.sleepc C s
t | t � S)z{ Errors when we're fairly sure that the server did not receive the
request, so it should be safe to retry.
)r$ r )r �errr r r �_is_connection_error� s zRetry._is_connection_errorc C s t | t t f � S)z� Errors that occur after the request has been started, so we should
assume that the server began processing it.
)r$ r r )r r1 r r r �_is_read_error� s zRetry._is_read_errorc C s8 | j r" | j � | j k r" d S| j o7 | | j k S)zR Is this method/status code retryable? (Based on method/codes whitelists)
F)r �upperr )r �method� status_coder r r �is_forced_retry� s zRetry.is_forced_retryc C sM | j | j | j | j f } t t d | � � } | s= d St | � d k S)z Are we out of retries? NFr )r r r r �list�filterr, )r Z retry_countsr r r � is_exhausted� s
zRetry.is_exhaustedc C s | j d k r0 | r0 t j t | � | | � � | j } | d k rO | d 8} | j } | j } | j }
| j } d } | r� | j | � r� | d k r� t j t | � | | � � n | d k r� | d 8} | d 7} n� | r=| j | � r=|
d k rt j t | � | | � � n |
d k r0|
d 8}
| d 7} nk | rn| j
� rn| d k re| d 8} d } n: | d 7} t j } | r�| j
r�t j j d | j
� } | j d | d | d |
d
| d | � }
|
j � r�t | | | p�t | � � � t j d | |
� |
S)
a� Return a new Retry object with incremented retry counters.
:param response: A response object, or None, if the server did not
return a response.
:type response: :class:`~urllib3.response.HTTPResponse`
:param Exception error: An error encountered during the request, or
None if the response was received successfully.
:return: A new ``Retry`` object.
FNr+ �unknownztoo many redirectsr6 r r r r r z$Incremented Retry for (url='%s'): %r)r r Zreraiser r r r r r2 r3 Zget_redirect_locationr Z
GENERIC_ERROR�statusZSPECIFIC_ERROR�formatr" r: r r& r' )r r5 Zurl�response�errorZ_poolZ _stacktracer r r r r �causeZ new_retryr r r � increment� sN
zRetry.incrementc C s d j d t | � d | � S)Nzf{cls.__name__}(total={self.total}, connect={self.connect}, read={self.read}, redirect={self.redirect})r( r )r= r )r r r r �__repr__ s zRetry.__repr__)�__name__�
__module__� __qualname__�__doc__� frozensetZDEFAULT_METHOD_WHITELISTr- r r" � classmethodr* r. r0 r2 r3 r7 r: rA rB r r r r r
s( \
Dr
� )Z
__future__r r/ �logging�
exceptionsr r r r r Zpackagesr � getLoggerrC r& �objectr
r# r r r r �<module> s (�