�
�g�G � �4 � d dl mZ d dlZd dlZd dlZd dlZd dlZd dlZd dlm Z d dl
m Z ddl m
Z
mZmZmZmZmZmZ ddlmZ ej, r dd lmZ dd
lmZ ej6 e � Z G d � d ej< � Z G d
� d� Z e d� e _! y)� )� annotationsN)� takewhile)�
TracebackType� )�ConnectTimeoutError�
InvalidHeader�
MaxRetryError�
ProtocolError�
ProxyError�ReadTimeoutError�
ResponseError� )�reraise)�ConnectionPool)�BaseHTTPResponsec �@ � e Zd ZU ded< ded< ded< ded< ded< y )
�RequestHistory�
str | None�method�url�Exception | None�error�
int | None�status�redirect_locationN)�__name__�
__module__� __qualname__�__annotations__� � �4/usr/lib/python3/dist-packages/urllib3/util/retry.pyr r s � � �� �O� �� ��!�!r! r c � � e Zd ZU dZ eg d�� Z eg d�� Z eg d�� ZdZde d< dd d d d d ed d
ed d d d ed f d d
�Z
d d�Z e d d d�� Z
d!d�Zd"d�Zd#d�Zd$d�Zd%d�Zd&d'd�Zd(d�Zd(d�Zd)d�Z d* d+d�Zd,d�Z d- d.d�Zd/d �Zy )0�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:
.. code-block:: python
retries = Retry(connect=5, read=2, redirect=5)
http = PoolManager(retries=retries)
response = http.request("GET", "https://example.com/")
Or per-request (which overrides the default for the pool):
.. code-block:: python
response = http.request("GET", "https://example.com/", retries=Retry(10))
Retries can be disabled by passing ``False``:
.. code-block:: python
response = http.request("GET", "https://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 Collection 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 ``None`` value to retry on any verb.
:param Collection 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 previous retries}))
seconds. If `backoff_jitter` is non-zero, this sleep is extended by::
random.uniform(0, {backoff jitter})
seconds. For example, if the backoff_factor is 0.1, then :func:`Retry.sleep` will
sleep for [0.0s, 0.2s, 0.4s, 0.8s, ...] between retries. No backoff will ever
be longer than `backoff_max`.
By default, backoff is disabled (factor 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 Collection 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�TRACE)i� i� i� )�Cookie�
AuthorizationzProxy-Authorization�x ztyping.ClassVar[Retry]�DEFAULT�
Nr T� c �< � || _ || _ || _ || _ || _ |du s|du rd}d} || _ |xs
t
� | _ || _ | | _ |
| _
| | _ | | _ |
xs d| _
|| _ t d� |D � � | _ || _ y )NFr r c 3 �< K � | ] }|j � �� � y �w�N)�lower)�.0�hs r" � <genexpr>z!Retry.__init__.<locals>.<genexpr>� s � �� � 4
��A�G�G�I�4
�s � )�total�connect�readr �other�redirect�set�status_forcelist�allowed_methods�backoff_factor� backoff_max�raise_on_redirect�raise_on_status�history�respect_retry_after_header� frozenset�remove_headers_on_redirect�backoff_jitter)�selfr8 r9 r: r< r r; r? r> r@ rA rB rC rD rE rG rH s r" �__init__zRetry.__init__� s� � �* ��
� �� ��� � �� ���
� �u� �����H� %� � ��
� 0� 9�C�E�� � .�� � ,���&���!2�� � .�� � �}�"�� �*D��'�*3� 4
� 9�4
� +
��'� -��r! c � � t di d| j �d| j �d| j �d| j �d| j
�d| j �d| j �d| j �d | j �d
| j �d | j �d | j �d
| j �d| j �d| j �d| j ��}|j# |� t% | � di |��S )Nr8 r9 r: r< r r; r? r> r@ rA rB rC rD rG rE rH r )�dictr8 r9 r: r< r r; r? r> r@ rA rB rC rD rG rE rH �update�type)rI �kw�paramss r" �newz Retry.new� s � ��
��*�*�
��L�L�
� ���
� �]�]�
�
�;�;�
� �*�*�
� !� 0� 0�
� "� 2� 2�
� �.�.�
� �(�(�
� #� 4� 4�
� !� 0� 0�
� �L�L�
� (,�'F�'F�
� (,�'F�'F�
� �.�.�!
��& �
�
�b���t�D�z�#�F�#�#r! c � � |�|�|n | j }t |t � r|S t |� xr d} | ||�� }t j d||� |S )z3Backwards-compatibility for the old retries format.N)r< z!Converted retries value: %r -> %r)r. �
isinstancer$ �bool�log�debug)�cls�retriesr< �default� new_retriess r" �from_intzRetry.from_int sY � � �?�!(�!4�g�#�+�+�G� �g�u� %��N���>�*�d���'�H�5� � � � �5�w� �L��r! c
�T � t t t d� t | j � � � � }|dk ry| j
d|dz
z z }| j dk7 r$|t j � | j z z
}t t dt | j |� � � S )zIFormula for computing the current backoff
:rtype: float
c � � | j d u S r3 )r )�xs r" �<lambda>z(Retry.get_backoff_time.<locals>.<lambda>' s � �A�$7�$7�4�$?� r! r r r r0 ) �len�listr �reversedrD r@ rH �random�float�max�minrA )rI �consecutive_errors_len�
backoff_values r" �get_backoff_timezRetry.get_backoff_time s� � � "%� ��?��$�,�,�AW�X�
�"
� �
"�Q� &�� �+�+�q�5K�a�5O�/P�Q�
� � � �#� %� �V�]�]�_�t�/B�/B� B� B�M��S��C�� 0� 0�-� @�A�B�Br! c �, � t j d|� r t |� }net j j |� }|�t
d|� �� �t j j |� }|t j � z
}t |d� }|S )Nz^\s*[0-9]+\s*$z Invalid Retry-After header: r )
�re�match�int�email�utils� parsedate_tzr � mktime_tz�timere )rI � retry_after�seconds�retry_date_tuple�
retry_dates r" �parse_retry_afterzRetry.parse_retry_after2 s� � � �8�8�%�{� 3��+�&�G� $�{�{� 7� 7� � D� � �'�#�&B�;�-�$P�Q�Q� ���.�.�/?�@�J� �4�9�9�;�.�G��g�q�/���r! c �` � |j j d� }|�y| j |� S )z(Get the value of Retry-After in seconds.z Retry-AfterN)�headers�getrw �rI �responsers s r" �get_retry_afterzRetry.get_retry_afterC s4 � � �&�&�*�*�=�9� � � ���%�%�k�2�2r! c �V � | j |� }|rt j |� yy)NTF)r} rr �sleepr{ s r" �sleep_for_retryzRetry.sleep_for_retryM s' � ��*�*�8�4� � � �J�J�{� #��r! c �Z � | j � }|dk ry t j |� y )Nr )ri rr r )rI �backoffs r" �_sleep_backoffzRetry._sleep_backoffU s& � ��'�'�)�� �a�<� � �
�
�7�r! c �h � | j r|r| j |� }|ry| j � y)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)rE r� r� )rI r| �slepts r" r z Retry.sleep[ s1 � � � *� *�x��(�(��2�E��� ��� r! c �Z � t |t � r |j }t |t � S )zzErrors when we're fairly sure that the server did not receive the
request, so it should be safe to retry.
)rS r �original_errorr �rI �errs r" �_is_connection_errorzRetry._is_connection_errork s' � � �c�:� &��$�$�C��#� 2�3�3r! c �. � t |t t f� S )zErrors that occur after the request has been started, so we should
assume that the server began processing it.
)rS r r
r� s r" �_is_read_errorzRetry._is_read_errors s � � �#� 0�-� @�A�Ar! c �V � | j r |j � | j vryy)zyChecks if a given HTTP method should be retried upon, depending if
it is included in the allowed_methods
FT)r? �upper)rI r s r" �_is_method_retryablezRetry._is_method_retryabley s& � � � � �F�L�L�N�$�:N�:N�$N��r! c �� � | j |� sy| j r|| j v ryt | j xr | j xr |xr || j
v � 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)r� r> rT r8 rE �RETRY_AFTER_STATUS_CODES)rI r � status_code�has_retry_afters r" �is_retryzRetry.is_retry� sm � � �(�(��0�� � � �[�D�4I�4I�%I��� �J�J�
?��/�/�
?� �
?� �� =� =�=�
�
r! c �� � | j | j | j | j | j | j
fD �cg c] }|r|�� }}|syt
|� dk S c c}w )zAre we out of retries?Fr )r8 r9 r: r< r r; rf )rI r^ � retry_countss r" � is_exhaustedzRetry.is_exhausted� so � �
�
�
�� � �� � ��
�
�� � ��
�
�
�
�� �
�
� �
� ���<� �1�$�$��
s � A%c �* � | j du r|rt t |� ||� �| j }|�|dz }| j }| j } | j
}
| j } | j } d}
d}d}|r3| j |� r"|du rt t |� ||� �|��|dz }n�|rF| j |� r5| du s|�| j |� st t |� ||� �| ��| dz } n�|r| ��| dz } n�|r:|j � r*|
�|
dz }
d}
|j � }|r|}|j }n[t j }
|rI|j r=| �| dz } t j j |j �� }
|j }| j t# |||||� fz }| j% ||| |
| | |�� }|j' � r |xs t |
� }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.BaseHTTPResponse`
: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� )r8 r9 r: r< r r; rD z$Incremented Retry for (url='%s'): %r)r8 r rN r9 r: r< r r; r� r� r� �get_redirect_locationr
�
GENERIC_ERROR�SPECIFIC_ERROR�formatrD r rQ r� r rU rV )rI r r r| r �_pool� _stacktracer8 r9 r: r< � status_countr; �causer r �response_redirect_locationrD � new_retry�reasons r" � incrementzRetry.increment� s3 � �& �:�:�� �5��$�u�+�u�k�:� :��
�
�� � � �Q�J�E��,�,���y�y���=�=���{�{� ��
�
������ �� �T�.�.�u�5��%� � �d�5�k�5�+�>�>��$��1� ��
�t�*�*�5�1��u�}���d�6O�6O�PV�6W� �d�5�k�5�+�>�>��!��� ��
�� ���
��
�(�8�8�:��#��A�
��(�E�)1�)G�)G�)I� &�)�$>�!� �_�_�F�
"�/�/�E��H�O�O� �+� �A�%�L�%�4�4�;�;����;�X��!� � ���,�,� �6�3��v�7H� I�"
�
�� �H�H���� � ��� �
� � � !� !� #��2�m�E� 2�F� ��s�F�3�� ?� � � �8�#�y�I��r! c � � t | � j � d| j � d| j � d| j � d| j
� d| j � d� S )Nz(total=z
, connect=z, read=z , redirect=z , status=�))rN r r8 r9 r: r< r )rI s r" �__repr__zRetry.__repr__ sV � ��D�z�"�"�#�7�4�:�:�,�j�� � �� O��I�I�;�k�$�-�-� � �$�+�+� �a�
Q�
r! )"r8 �bool | int | Noner9 r r: r r< r� r r r; r r? z typing.Collection[str] | Noner> z typing.Collection[int] | Noner@ rd rA rd rB rT rC rT rD z!tuple[RequestHistory, ...] | NonerE rT rG ztyping.Collection[str]rH rd �return�None)rO z
typing.Anyr� r$ )TN)rX �Retry | bool | int | Noner< r� rY r� r� r$ )r� rd )rs �strr� rd )r| r r� z float | None)r| r r� rT )r� r� r3 )r| �BaseHTTPResponse | Noner� r� )r� � Exceptionr� rT )r r� r� rT )F)r r� r� rm r� rT r� rT )r� rT )NNNNNN)r r r r r| r� r r r� zConnectionPool | Noner� zTracebackType | Noner� r$ )r� r� )r r r �__doc__rF �DEFAULT_ALLOWED_METHODSr� �"DEFAULT_REMOVE_HEADERS_ON_REDIRECT�DEFAULT_BACKOFF_MAXr rJ rQ � classmethodr[ ri rw r} r� r� r r� r� r� r� r� r� r� r r! r" r$ r$ ' s: � �K�\ (�<� ��
)� � 9� � *3�:�*�&�
�� $�#� $&� "� �&*� !� �9P�:>� !� 0�"&� $�59�+/�
/� #�'+-� �+-� �+-� � +-�
$� +-� �
+-� �+-� 7�+-� 8�+-� �+-� �+-� �+-� �+-� 3� +-� %)� +-� %
�!+-�& �'+-�(
�)+-�Z$�. � '+�-1� �*�� $�� +� �
� � ��$C�&�"3�� � � 4�B� � FK�
��
�(+�
�>B�
�
�
�,%�* "� �,0�"&�'+�,0�_��_� �_� *� _�
� _� %�
_� *�_�
�_�B
r! r$ � )"�
__future__r rn �loggingrc rk rr �typing� itertoolsr �typesr �
exceptionsr r r r
r r r
�utilr �
TYPE_CHECKING�connectionpoolr r| r � getLoggerr rU �
NamedTupler r$ r. r r! r" �<module>r� s� �� "� � �
� � �
� � �� � � � ���/�+��g����!��"�V�&�&� "�h
� h
�X �a���
r! |