a oeU@sddlmZddlZddlZddlZddlZddlZddlmZddl m Z ddl m Z m Z mZmZmZmZmZddlmZeeZedgd ZeZGd d d eZeeGd d d eZede_dS))absolute_importN) namedtuple) takewhile)ConnectTimeoutError InvalidHeader MaxRetryError ProtocolError ProxyErrorReadTimeoutError ResponseError)sixRequestHistory)methodurlerrorstatusredirect_locationc@sZeZdZeddZejddZeddZejddZeddZejd dZd S) _RetryMetacCstdt|jSNz}Using 'Retry.DEFAULT_METHOD_WHITELIST' is deprecated and will be removed in v2.0. Use 'Retry.DEFAULT_ALLOWED_METHODS' insteadwarningswarnDeprecationWarningDEFAULT_ALLOWED_METHODSclsr3C:\Program Files\Certbot\pkgs\urllib3\util\retry.pyDEFAULT_METHOD_WHITELIST$s z#_RetryMeta.DEFAULT_METHOD_WHITELISTcCstdt||_dSrrrvaluerrrr-s cCstdt|jSNzUsing 'Retry.DEFAULT_REDIRECT_HEADERS_BLACKLIST' is deprecated and will be removed in v2.0. Use 'Retry.DEFAULT_REMOVE_HEADERS_ON_REDIRECT' insteadrrr"DEFAULT_REMOVE_HEADERS_ON_REDIRECTrrrr"DEFAULT_REDIRECT_HEADERS_BLACKLIST6s z-_RetryMeta.DEFAULT_REDIRECT_HEADERS_BLACKLISTcCstdt||_dSr"r#r rrrr%?s cCstdt|jSNzlUsing 'Retry.BACKOFF_MAX' is deprecated and will be removed in v2.0. Use 'Retry.DEFAULT_BACKOFF_MAX' insteadrrrDEFAULT_BACKOFF_MAXrrrr BACKOFF_MAXHs z_RetryMeta.BACKOFF_MAXcCstdt||_dSr&r'r rrrr)Qs N)__name__ __module__ __qualname__propertyrsetterr%r)rrrrr#s     rcseZdZdZegdZegdZeddgZdZdddddde dd d d dd e e fd d Z d dZ e d.ddZ ddZddZddZd/ddZddZd0ddZddZdd Zd!d"Zd1d$d%Zd&d'Zd2d(d)Zd*d+Zfd,d-ZZS)3RetryaJRetry 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. )ZHEADZGETZPUTZDELETEZOPTIONSZTRACE)iiiZCookieZ Authorizationx NrTcCs|tur,|turtdtjdtdd|}|tur:|j}|turH|j}||_||_||_ ||_ ||_ |dusv|dur~d}d} ||_ |pt |_||_| |_| |_| |_| pt|_| |_tdd|D|_dS) 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) stacklevelFrcSsg|] }|qSr)lower).0hrrr -z"Retry.__init__..)_Default ValueErrorrrrrr$totalconnectreadrotherredirectsetstatus_forcelistallowed_methodsbackoff_factorraise_on_redirectraise_on_statustuplehistoryrespect_retry_after_header frozensetremove_headers_on_redirect)selfr;r<r=r?rr>rBrArCrDrErGrHrJmethod_whitelistrrr__init__sD   zRetry.__init__cKst|j|j|j|j|j|j|j|j|j |j |j |j |j d }d|vrxd|vrxd|jvrntdt|j|d<n |j|d<||t|fi|S)N) r;r<r=r?rr>rArCrDrErGrJrHrLrBr2)dictr;r<r=r?rr>rArCrDrErGrJrH__dict__rrrrBupdatetype)rKkwparamsrrrnew0s2    z Retry.newcCsR|dur|dur|n|j}t|tr(|St|o2d}|||d}td|||S)z3Backwards-compatibility for the old retries format.N)r?z!Converted retries value: %r -> %r)DEFAULT isinstancer/boollogdebug)rZretriesr?defaultZ new_retriesrrrfrom_intTs   zRetry.from_intcCsFtttddt|j}|dkr(dS|jd|d}t|j|S)zIFormula for computing the current backoff :rtype: float cSs |jduS)N)r)xrrrjr8z(Retry.get_backoff_time..rr)lenlistrreversedrGrCminr()rKZconsecutive_errors_lenZ backoff_valuerrrget_backoff_timebszRetry.get_backoff_timecCstd|rt|}n`tj|}|dur6td||ddur^|ddd|dd}tj|}|t}|dkrd}|S)Nz^\s*[0-9]+\s*$zInvalid Retry-After header: %s )rr1r) rematchintemailZutilsZ parsedate_tzrZ mktime_tztime)rK retry_afterZsecondsZretry_date_tupleZ retry_daterrrparse_retry_afterss       zRetry.parse_retry_aftercCs"|jd}|durdS||S)z(Get the value of Retry-After in seconds.z Retry-AfterN)ZheadersgetrkrKresponserjrrrget_retry_afters zRetry.get_retry_aftercCs ||}|rt|dSdS)NTF)rorisleeprmrrrsleep_for_retrys   zRetry.sleep_for_retrycCs"|}|dkrdSt|dS)Nr)rcrirp)rKZbackoffrrr_sleep_backoffszRetry._sleep_backoffcCs(|jr|r||}|rdS|dS)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)rHrqrr)rKrnZsleptrrrrps  z Retry.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. )rVr Zoriginal_errorrrKerrrrr_is_connection_errors zRetry._is_connection_errorcCst|ttfS)zErrors that occur after the request has been started, so we should assume that the server began processing it. )rVr r rsrrr_is_read_errorszRetry._is_read_errorcCs<d|jvrtdt|j}n|j}|r8||vr8dSdS)zyChecks if a given HTTP method should be retried upon, depending if it is included in the allowed_methods rLr2FT)rOrrrrLrBupper)rKrrBrrr_is_method_retryables zRetry._is_method_retryableFcCs<||sdS|jr"||jvr"dS|jo:|jo:|o:||jvS)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)rxrAr;rHRETRY_AFTER_STATUS_CODES)rKr status_codeZhas_retry_afterrrris_retrys zRetry.is_retrycCs>|j|j|j|j|j|jf}ttd|}|s2dSt|dkS)zAre we out of retries?NFr) r;r<r=r?rr>r`filterrb)rKZ retry_countsrrr is_exhaustedszRetry.is_exhaustedc Cs|jdur |r tt||||j}|dur6|d8}|j}|j} |j} |j} |j} d} d}d}|r| |r|durtt|||n|dur|d8}n|r| |r| dus| |stt|||n| dur| d8} n|r| dur| d8} nr|r.| r.| dur| d8} d} | }|j}nrGz$Incremented Retry for (url='%s'): %r)r;r ZreraiserQr<r=r?rr>rurvrxZget_redirect_locationr Z GENERIC_ERRORZSPECIFIC_ERRORformatrGrrTr}rrXrY)rKrrrnrZ_poolZ _stacktracer;r<r=r?Z status_countr>causerrrGZ new_retryrrr incrementsl      zRetry.incrementcCsdjt||dS)Nz|{cls.__name__}(total={self.total}, connect={self.connect}, read={self.read}, redirect={self.redirect}, status={self.status}))rrK)rrQ)rKrrr__repr__VszRetry.__repr__csN|dkrtdt|jSzttt||WStyHtt|YS0dS)NrLr2)rrrrBgetattrsuperr/AttributeError)rKitem __class__rr __getattr__\s zRetry.__getattr__)TN)N)N)F)NNNNNN)r*r+r,__doc__rIrryr$r(r9rMrT classmethodr[rcrkrorqrrrprurvrxr{r}rrr __classcell__rrrrr/[s^    =$     ^r/) Z __future__rrhZloggingrerir collectionsr itertoolsr exceptionsrrrr r r r Zpackagesr Z getLoggerr*rXrobjectr9rQrZ add_metaclassr/rUrrrrs,   $  8