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

Public Member Functions

def __init__ (self, sleep=sleep, stop=stop_never, wait=wait_none(), retry=retry_if_exception_type(), before=before_nothing, after=after_nothing, before_sleep=None, reraise=False, retry_error_cls=RetryError, retry_error_callback=None)
 
def copy (self, sleep=_unset, stop=_unset, wait=_unset, retry=_unset, before=_unset, after=_unset, before_sleep=_unset, reraise=_unset, retry_error_cls=_unset, retry_error_callback=_unset)
 
def __repr__ (self)
 
def statistics (self)
 
def wraps (self, f)
 
def begin (self, fn)
 
def iter (self, retry_state)
 
def __iter__ (self)
 
def __call__ (self, *args, **kwargs)
 
def call (self, *args, **kwargs)
 

Data Fields

 sleep
 
 stop
 
 wait
 
 retry
 
 before
 
 after
 
 before_sleep
 
 reraise
 
 retry_error_cls
 
 retry_error_callback
 
 fn
 

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  sleep = sleep,
  stop = stop_never,
  wait = wait_none(),
  retry = retry_if_exception_type(),
  before = before_nothing,
  after = after_nothing,
  before_sleep = None,
  reraise = False,
  retry_error_cls = RetryError,
  retry_error_callback = None 
)

Member Function Documentation

◆ __call__()

def __call__ (   self,
args,
**  kwargs 
)

◆ __iter__()

def __iter__ (   self)

◆ __repr__()

def __repr__ (   self)

◆ begin()

def begin (   self,
  fn 
)

◆ call()

def call (   self,
args,
**  kwargs 
)
Use ``__call__`` instead because this method is deprecated.

◆ copy()

def copy (   self,
  sleep = _unset,
  stop = _unset,
  wait = _unset,
  retry = _unset,
  before = _unset,
  after = _unset,
  before_sleep = _unset,
  reraise = _unset,
  retry_error_cls = _unset,
  retry_error_callback = _unset 
)
Copy this object with some parameters changed if needed.

◆ iter()

def iter (   self,
  retry_state 
)

◆ statistics()

def statistics (   self)
Return a dictionary of runtime statistics.

This dictionary will be empty when the controller has never been
ran. When it is running or has ran previously it should have (but
may not) have useful and/or informational keys and values when
running is underway and/or completed.

.. warning:: The keys in this dictionary **should** be some what
     stable (not changing), but there existence **may**
     change between major releases as new statistics are
     gathered or removed so before accessing keys ensure that
     they actually exist and handle when they do not.

.. note:: The values in this dictionary are local to the thread
  running call (so if multiple threads share the same retrying
  object - either directly or indirectly) they will each have
  there own view of statistics they have collected (in the
  future we may provide a way to aggregate the various
  statistics from each thread).

◆ wraps()

def wraps (   self,
  f 
)
Wrap a function for retrying.

:param f: A function to wraps for retrying.

Reimplemented in AsyncRetrying.

Field Documentation

◆ after

after

◆ before

before

◆ before_sleep

before_sleep

◆ fn

fn

◆ reraise

reraise

◆ retry

retry

◆ retry_error_callback

retry_error_callback

◆ retry_error_cls

retry_error_cls

◆ sleep

sleep

◆ stop

stop

◆ wait

wait

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