www.ravenbrook.com - retry.cpython-36.pyc

3

Z'ícóUã@sØddlmZddlZddlZddlZddlZddlZddlmZddl	m
Z
ddlmZm
Z
mZmZmZmZmZddlmZejeZedd	d
ddd
gZeZGdddeZejeGdddeZede_dS)é)Úabsolute_importN)Ú
namedtuple)Ú	takewhileé)ÚConnectTimeoutErrorÚ
InvalidHeaderÚ
MaxRetryErrorÚ
ProtocolErrorÚ
ProxyErrorÚReadTimeoutErrorÚ
ResponseError)ÚsixÚRequestHistoryÚmethodÚurlÚerrorÚstatusÚredirect_locationc@sZeZdZeddZejddZeddZejddZeddZejd	dZd
S)Ú
_RetryMetacCstjdt|jS)Nz}Using 'Retry.DEFAULT_METHOD_WHITELIST' is deprecated and will be removed in v2.0. Use 'Retry.DEFAULT_ALLOWED_METHODS' instead)ÚwarningsÚwarnÚDeprecationWarningÚDEFAULT_ALLOWED_METHODS)Úcls©rú5/tmp/pip-build-gk9425m9/urllib3/urllib3/util/retry.pyÚDEFAULT_METHOD_WHITELIST$sz#_RetryMeta.DEFAULT_METHOD_WHITELISTcCstjdt||_dS)Nz}Using 'Retry.DEFAULT_METHOD_WHITELIST' is deprecated and will be removed in v2.0. Use 'Retry.DEFAULT_ALLOWED_METHODS' instead)rrrr)rÚvaluerrrr-scCstjdt|jS)NzUsing 'Retry.DEFAULT_REDIRECT_HEADERS_BLACKLIST' is deprecated and will be removed in v2.0. Use 'Retry.DEFAULT_REMOVE_HEADERS_ON_REDIRECT' instead)rrrÚ"DEFAULT_REMOVE_HEADERS_ON_REDIRECT)rrrrÚ"DEFAULT_REDIRECT_HEADERS_BLACKLIST6sz-_RetryMeta.DEFAULT_REDIRECT_HEADERS_BLACKLISTcCstjdt||_dS)NzUsing 'Retry.DEFAULT_REDIRECT_HEADERS_BLACKLIST' is deprecated and will be removed in v2.0. Use 'Retry.DEFAULT_REMOVE_HEADERS_ON_REDIRECT' instead)rrrr)rrrrrr?scCstjdt|jS)NzlUsing 'Retry.BACKOFF_MAX' is deprecated and will be removed in v2.0. Use 'Retry.DEFAULT_BACKOFF_MAX' instead)rrrÚDEFAULT_BACKOFF_MAX)rrrrÚBACKOFF_MAXHsz_RetryMeta.BACKOFF_MAXcCstjdt||_dS)NzlUsing 'Retry.BACKOFF_MAX' is deprecated and will be removed in v2.0. Use 'Retry.DEFAULT_BACKOFF_MAX' instead)rrrr )rrrrrr!QsN)Ú__name__Ú
__module__Ú__qualname__ÚpropertyrÚsetterrr!rrrrr#s					rcsþeZdZdZeddddddgZedd	d
gZedgZdZd
ddddde	dddddde	e	fddZ
ddZed4ddZ
ddZddZddZd5ddZdd Zd6d!d"Zd#d$Zd%d&Zd'd(Zd7d*d+Zd,d-Zd8d.d/Zd0d1Zfd2d3ZZS)9ÚRetryaJRetry 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.DEFAULT_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.
    ÚHEADÚGETÚPUTÚDELETEÚOPTIONSÚTRACEiii÷Ú
Authorizationéxé
NrTcCsÒ|tk	r,|tk	rtdtjdtdd|}|tkr:|j}|tkrH|j}||_||_||_	||_
||_|dksv|dkr~d}d}
||_|pt
|_||_|	|_|
|_||_|p°t|_|
|_tdd|D|_dS)	NzoUsing both 'allowed_methods' and 'method_whitelist' together is not allowed. Instead only use 'allowed_methods'zlUsing 'method_whitelist' with Retry is deprecated and will be removed in v2.0. Use 'allowed_methods' insteadr)Ú
stacklevelFrcSsg|]}|jqSr)Úlower)Ú.0Úhrrrú
<listcomp>-sz"Retry.__init__.<locals>.<listcomp>)Ú_DefaultÚ
ValueErrorrrrrrÚtotalÚconnectÚreadrÚotherÚredirectÚsetÚstatus_forcelistÚallowed_methodsÚbackoff_factorÚraise_on_redirectÚraise_on_statusÚtupleÚhistoryÚrespect_retry_after_headerÚ	frozensetÚremove_headers_on_redirect)Úselfr8r9r:r<rr;r?r>r@rArBrDrErGÚmethod_whitelistrrrÚ__init__ós>zRetry.__init__cKst|j|j|j|j|j|j|j|j|j	|j
|j|j|j
d
}d|krxd|krxd|jkrntjdt|j|d<n
|j|d<|j|t|f|S)N)
r8r9r:r<rr;r>r@rArBrDrGrErIr?zlUsing 'method_whitelist' with Retry is deprecated and will be removed in v2.0. Use 'allowed_methods' instead)Údictr8r9r:r<rr;r>r@rArBrDrGrEÚ__dict__rrrr?ÚupdateÚtype)rHÚkwÚparamsrrrÚnew0s.



z	Retry.newcCsR|dkr|dk	r|n|j}t|tr(|St|o2d}|||d}tjd|||S)z3Backwards-compatibility for the old retries format.N)r<z!Converted retries value: %r -> %r)ÚDEFAULTÚ
isinstancer'ÚboolÚlogÚdebug)rÚretriesr<ÚdefaultÚnew_retriesrrrÚfrom_intTs
zRetry.from_intcCsFtttddt|j}|dkr(dS|jd|d}t|j|S)zIFormula for computing the current backoff

        :rtype: float
        cSs
|jdkS)N)r)ÚxrrrÚ<lambda>jsz(Retry.get_backoff_time.<locals>.<lambda>érr)ÚlenÚlistrÚreversedrDr@Úminr )rHÚconsecutive_errors_lenÚ
backoff_valuerrrÚget_backoff_timebszRetry.get_backoff_timecCstjd|rt|}n`tjj|}|dkr6td||ddkr^|ddd|dd}tjj|}|tj}|dkrd}|S)Nz^\s*[0-9]+\s*$zInvalid Retry-After header: %sé	rr0)r)	ÚreÚmatchÚintÚemailÚutilsÚparsedate_tzrÚ	mktime_tzÚtime)rHÚretry_afterÚsecondsÚretry_date_tupleÚ
retry_daterrrÚparse_retry_afterss
zRetry.parse_retry_aftercCs"|jjd}|dkrdS|j|S)z(Get the value of Retry-After in seconds.zRetry-AfterN)ÚheadersÚgetrr)rHÚresponsernrrrÚget_retry_afterszRetry.get_retry_aftercCs |j|}|rtj|dSdS)NTF)rvrmÚsleep)rHrurnrrrÚsleep_for_retrys


zRetry.sleep_for_retrycCs"|j}|dkrdStj|dS)Nr)rdrmrw)rHÚbackoffrrrÚ_sleep_backoffszRetry._sleep_backoffcCs(|jr|r|j|}|rdS|jdS)aBSleep 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)rErxrz)rHruÚsleptrrrrw¢s
	

zRetry.sleepcCst|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.
        )rSr
Úoriginal_errorr)rHÚerrrrrÚ_is_connection_error²s
zRetry._is_connection_errorcCst|ttfS)zErrors that occur after the request has been started, so we should
        assume that the server began processing it.
        )rSrr	)rHr}rrrÚ_is_read_errorºszRetry._is_read_errorcCs<d|jkrtjdt|j}n|j}|r8|j|kr8dSdS)zyChecks if a given HTTP method should be retried upon, depending if
        it is included in the allowed_methods
        rIzlUsing 'method_whitelist' with Retry is deprecated and will be removed in v2.0. Use 'allowed_methods' insteadFT)rLrrrrIr?Úupper)rHrr?rrrÚ_is_method_retryableÀs
zRetry._is_method_retryableFcCs<|j|sdS|jr"||jkr"dS|jo:|jo:|o:||jkS)awIs 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)rr>r8rEÚRETRY_AFTER_STATUS_CODES)rHrÚstatus_codeÚhas_retry_afterrrrÚis_retryÔs
zRetry.is_retrycCs>|j|j|j|j|j|jf}ttd|}|s2dSt|dkS)zAre we out of retries?NFr)	r8r9r:r<rr;r_Úfilterra)rHÚretry_countsrrrÚis_exhaustedèszRetry.is_exhaustedc	CsÎ|jdkr |r tjt||||j}|dk	r6|d8}|j}|j}	|j}
|j}|j}d}
d}d}|r|j	|r|dkrtjt|||n|dk	r|d8}nÐ|rä|j
|rä|	dks¾|j|rÒtjt|||n|	dk	râ|	d8}	n|rú|dk	rø|d8}nr|r0|jr0|
dk	r|
d8}
d}
|j}|j}n<t
j}
|rl|jrl|dk	rV|d8}t
jj|jd}
|j}|jt|||||f}|j|||	|
|||d}|jr¼t|||p¸t
|
tjd|||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 redirects)r)r8r9r:r<rr;rDz$Incremented Retry for (url='%s'): %r)r8r
ÚreraiserNr9r:r<rr;r~rrÚget_redirect_locationrÚ
GENERIC_ERRORÚSPECIFIC_ERRORÚformatrDrrQrrrUrV)rHrrrurÚ_poolÚ_stacktracer8r9r:r<Ústatus_countr;ÚcauserrrDÚ	new_retryrrrÚ	incrementøsh





zRetry.incrementcCsdjt||dS)Nz|{cls.__name__}(total={self.total}, connect={self.connect}, read={self.read}, redirect={self.redirect}, status={self.status}))rrH)rrN)rHrrrÚ__repr__VszRetry.__repr__csJ|dkrtjdt|jSyttt||Stk
rDtt|SXdS)NrIzlUsing 'method_whitelist' with Retry is deprecated and will be removed in v2.0. Use 'allowed_methods' instead)rrrr?ÚgetattrÚsuperr'ÚAttributeError)rHÚitem)Ú	__class__rrÚ__getattr__\szRetry.__getattr__)TN)N)N)F)NNNNNN)r"r#r$Ú__doc__rFrrrr r6rJrQÚclassmethodrZrdrrrvrxrzrwr~rrrrrrrÚ
__classcell__rr)rrr'[sX	
,$





Wr'é) Ú
__future__rriÚloggingrfrmrÚcollectionsrÚ	itertoolsrÚ
exceptionsrrrr	r
rrÚpackagesr
Ú	getLoggerr"rUrÚobjectr6rNrÚ
add_metaclassr'rRrrrrÚ<module>s*$	
8