OpenQuizz
Une application de gestion des contenus pédagogiques
Retry Class Reference
Inheritance diagram for Retry:
Collaboration diagram for Retry:

Public Member Functions

def __init__ (self, total=10, connect=None, read=None, redirect=None, status=None, other=None, allowed_methods=_Default, status_forcelist=None, backoff_factor=0, raise_on_redirect=True, raise_on_status=True, history=None, respect_retry_after_header=True, remove_headers_on_redirect=_Default, method_whitelist=_Default)
 
def new (self, **kw)
 
def from_int (cls, retries, redirect=True, default=None)
 
def get_backoff_time (self)
 
def parse_retry_after (self, retry_after)
 
def get_retry_after (self, response)
 
def sleep_for_retry (self, response=None)
 
def sleep (self, response=None)
 
def is_retry (self, method, status_code, has_retry_after=False)
 
def is_exhausted (self)
 
def increment (self, method=None, url=None, response=None, error=None, _pool=None, _stacktrace=None)
 
def __repr__ (self)
 
def __getattr__ (self, item)
 

Data Fields

 total
 
 connect
 
 read
 
 status
 
 other
 
 redirect
 
 status_forcelist
 
 allowed_methods
 
 backoff_factor
 
 raise_on_redirect
 
 raise_on_status
 
 history
 
 respect_retry_after_header
 
 remove_headers_on_redirect
 

Static Public Attributes

 DEFAULT_ALLOWED_METHODS
 
 RETRY_AFTER_STATUS_CODES
 
 DEFAULT_REMOVE_HEADERS_ON_REDIRECT
 
 BACKOFF_MAX
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  total = 10,
  connect = None,
  read = None,
  redirect = None,
  status = None,
  other = None,
  allowed_methods = _Default,
  status_forcelist = None,
  backoff_factor = 0,
  raise_on_redirect = True,
  raise_on_status = True,
  history = None,
  respect_retry_after_header = True,
  remove_headers_on_redirect = _Default,
  method_whitelist = _Default 
)

Member Function Documentation

◆ __getattr__()

def __getattr__ (   self,
  item 
)

◆ __repr__()

def __repr__ (   self)

◆ from_int()

def from_int (   cls,
  retries,
  redirect = True,
  default = None 
)
Backwards-compatibility for the old retries format.

◆ get_backoff_time()

def get_backoff_time (   self)
Formula for computing the current backoff

:rtype: float

◆ get_retry_after()

def get_retry_after (   self,
  response 
)
Get the value of Retry-After in seconds. 

◆ increment()

def increment (   self,
  method = None,
  url = None,
  response = None,
  error = None,
  _pool = None,
  _stacktrace = None 
)
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.

◆ is_exhausted()

def is_exhausted (   self)
Are we out of retries? 

◆ is_retry()

def is_retry (   self,
  method,
  status_code,
  has_retry_after = False 
)
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)

◆ new()

def new (   self,
**  kw 
)

◆ parse_retry_after()

def parse_retry_after (   self,
  retry_after 
)

◆ sleep()

def sleep (   self,
  response = None 
)
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.

◆ sleep_for_retry()

def sleep_for_retry (   self,
  response = None 
)

Field Documentation

◆ allowed_methods

allowed_methods

◆ backoff_factor

backoff_factor

◆ BACKOFF_MAX

BACKOFF_MAX
static

◆ connect

connect

◆ DEFAULT_ALLOWED_METHODS

DEFAULT_ALLOWED_METHODS
static

◆ DEFAULT_REMOVE_HEADERS_ON_REDIRECT

DEFAULT_REMOVE_HEADERS_ON_REDIRECT
static

◆ history

history

◆ other

other

◆ raise_on_redirect

raise_on_redirect

◆ raise_on_status

raise_on_status

◆ read

read

◆ redirect

redirect

◆ remove_headers_on_redirect

remove_headers_on_redirect

◆ respect_retry_after_header

respect_retry_after_header

◆ RETRY_AFTER_STATUS_CODES

RETRY_AFTER_STATUS_CODES
static

◆ status

status

◆ status_forcelist

status_forcelist

◆ total

total

The documentation for this class was generated from the following file: