pip._vendor.tenacity.BaseRetrying Class Reference

Inheritance diagram for pip._vendor.tenacity.BaseRetrying:

Collaboration diagram for pip._vendor.tenacity.BaseRetrying:

Public Member Functions
	__init__ (self, t.Callable[[t.Union[int, float]], None] sleep=sleep, "StopBaseT" stop=stop_never, "WaitBaseT" wait=wait_none(), "RetryBaseT" retry=retry_if_exception_type(), t.Callable[["RetryCallState"], None] before=before_nothing, t.Callable[["RetryCallState"], None] after=after_nothing, t.Optional[t.Callable[["RetryCallState"], None]] before_sleep=None, bool reraise=False, t.Type[RetryError] retry_error_cls=RetryError, t.Optional[t.Callable[["RetryCallState"], t.Any]] retry_error_callback=None)
"BaseRetrying"	copy (self, t.Union[t.Callable[[t.Union[int, float]], None], object] sleep=_unset, t.Union["StopBaseT", object] stop=_unset, t.Union["WaitBaseT", object] wait=_unset, t.Union[retry_base, object] retry=_unset, t.Union[t.Callable[["RetryCallState"], None], object] before=_unset, t.Union[t.Callable[["RetryCallState"], None], object] after=_unset, t.Union[t.Optional[t.Callable[["RetryCallState"], None]], object] before_sleep=_unset, t.Union[bool, object] reraise=_unset, t.Union[t.Type[RetryError], object] retry_error_cls=_unset, t.Union[t.Optional[t.Callable[["RetryCallState"], t.Any]], object] retry_error_callback=_unset)
str	__repr__ (self)
t.Dict[str, t.Any]	statistics (self)
WrappedFn	wraps (self, WrappedFn f)
None	begin (self)
t.Union[DoAttempt, DoSleep, t.Any]	iter (self, "RetryCallState" retry_state)
t.Generator[AttemptManager, None, None]	__iter__ (self)
WrappedFnReturnT	__call__ (self, t.Callable[..., WrappedFnReturnT] fn, *t.Any args, **t.Any kwargs)

Public Attributes
	sleep
	stop
	wait
	retry
	before
	after
	before_sleep
	reraise
	retry_error_cls
	retry_error_callback

Protected Attributes
	_local

Member Function Documentation

copy()

"BaseRetrying" pip._vendor.tenacity.BaseRetrying.copy	(		self,
		t.Union[t.Callable[[t.Union[int, float]], None], object]	sleep = _unset,
		t.Union["StopBaseT", object]	stop = _unset,
		t.Union["WaitBaseT", object]	wait = _unset,
		t.Union[retry_base, object]	retry = _unset,
		t.Union[t.Callable[["RetryCallState"], None], object]	before = _unset,
		t.Union[t.Callable[["RetryCallState"], None], object]	after = _unset,
		t.Union[t.Optional[t.Callable[["RetryCallState"], None]], object]	before_sleep = _unset,
		t.Union[bool, object]	reraise = _unset,
		t.Union[t.Type[RetryError], object]	retry_error_cls = _unset,
		t.Union[t.Optional[t.Callable[["RetryCallState"], t.Any]], object]	retry_error_callback = _unset
	)

Copy this object with some parameters changed if needed.

statistics()

t.Dict[str, t.Any] pip._vendor.tenacity.BaseRetrying.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()

WrappedFn pip._vendor.tenacity.BaseRetrying.wraps	(		self,
		WrappedFn	f
	)

Wrap a function for retrying.

:param f: A function to wraps for retrying.

Reimplemented in pip._vendor.tenacity._asyncio.AsyncRetrying.

---

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

• docs/help/help-venv/lib/python3.12/site-packages/pip/_vendor/tenacity/__init__.py