RetryCallState Class Reference

Public Member Functions
None	__init__ (self, BaseRetrying retry_object, t.Optional[WrappedFn] fn, t.Any args, t.Any kwargs)
t.Optional[float]	seconds_since_start (self)
None	prepare_for_next_attempt (self)
None	set_result (self, t.Any val)
None	set_exception (self, t.Tuple[t.Type[BaseException], BaseException, "types.TracebackType| None"] exc_info)
str	__repr__ (self)

Data Fields
	start_time
	retry_object
	fn
	args
	kwargs
	outcome
	outcome_timestamp
	next_action

Detailed Description

State related to a single call wrapped with Retrying.

Definition at line 425 of file __init__.py.

Constructor & Destructor Documentation

__init__()

None __init__	(		self,
		BaseRetrying	retry_object,
		t.Optional[WrappedFn]	fn,
		t.Any	args,
		t.Any	kwargs
	)

Definition at line 428 of file __init__.py.

    ) -> None:
        #: Retry call start timestamp
        self.start_time = time.monotonic()
        #: Retry manager object
        self.retry_object = retry_object
        #: Function wrapped by this retry call
        self.fn = fn
        #: Arguments of the function wrapped by this retry call
        self.args = args
        #: Keyword arguments of the function wrapped by this retry call
        self.kwargs = kwargs
 
        #: The number of the current attempt
        self.attempt_number: int = 1
        #: Last outcome (result or exception) produced by the function
        self.outcome: t.Optional[Future] = None
        #: Timestamp of the last outcome
        self.outcome_timestamp: t.Optional[float] = None
        #: Time spent sleeping in retries
        self.idle_for: float = 0.0
        #: Next action as decided by the retry manager
        self.next_action: t.Optional[RetryAction] = None
 

References i.

Referenced by Protocol.__init_subclass__().

Here is the caller graph for this function:

Member Function Documentation

__repr__()

str __repr__

(

self

)

Definition at line 483 of file __init__.py.

    def __repr__(self) -> str:
        if self.outcome is None:
            result = "none yet"
        elif self.outcome.failed:
            exception = self.outcome.exception()
            result = f"failed ({exception.__class__.__name__} {exception})"
        else:
            result = f"returned {self.outcome.result()}"
 
        slept = float(round(self.idle_for, 2))
        clsname = self.__class__.__name__
        return f"<{clsname} {id(self)}: attempt #{self.attempt_number}; slept for {slept}; last result: {result}>"
 
 
@t.overload

References FormatControl.__class__, _InstallRequirementBackedCandidate.__class__, AlreadyInstalledCandidate.__class__, ExtrasCandidate.__class__, OrderedDict.__class__, InfinityType.__class__, NegativeInfinityType.__class__, _IndividualSpecifier.__class__, Distribution.__class__, ParseExpression.__class__, ParamSpec.__class__, _ConcatenateGenericAlias.__class__, _UnpackAlias.__class__, TypeVarTuple.__class__, PoolError.__class__, RequestError.__class__, i, and RetryCallState.outcome.

prepare_for_next_attempt()

None prepare_for_next_attempt

(

self

)

Definition at line 463 of file __init__.py.

    def prepare_for_next_attempt(self) -> None:
        self.outcome = None
        self.outcome_timestamp = None
        self.attempt_number += 1
        self.next_action = None
 

seconds_since_start()

t.Optional[float] seconds_since_start

(

self

)

Definition at line 458 of file __init__.py.

    def seconds_since_start(self) -> t.Optional[float]:
        if self.outcome_timestamp is None:
            return None
        return self.outcome_timestamp - self.start_time
 

References RetryCallState.outcome_timestamp, Task.start_time, Spinner.start_time, and RetryCallState.start_time.

set_exception()

None set_exception	(		self,
		t.Tuple[t.Type[BaseException], BaseException, "types.TracebackType| None"]	exc_info
	)

Definition at line 475 of file __init__.py.

    ) -> None:
        ts = time.monotonic()
        fut = Future(self.attempt_number)
        fut.set_exception(exc_info[1])
        self.outcome, self.outcome_timestamp = fut, ts
 

References Future.attempt_number, i, RetryCallState.outcome, and RetryCallState.outcome_timestamp.

set_result()

None set_result	(		self,
		t.Any	val
	)

Definition at line 469 of file __init__.py.

    def set_result(self, val: t.Any) -> None:
        ts = time.monotonic()
        fut = Future(self.attempt_number)
        fut.set_result(val)
        self.outcome, self.outcome_timestamp = fut, ts
 

References Future.attempt_number, i, RetryCallState.outcome, and RetryCallState.outcome_timestamp.

Field Documentation

args

args

Definition at line 442 of file __init__.py.

Referenced by EditablePartial.__call__(), InvalidSchemeCombination.__str__(), VersionConflict.dist(), VersionConflict.req(), DistributionNotFound.req(), ContextualVersionConflict.required_by(), DistributionNotFound.requirers(), and VersionConflict.with_context().

fn

fn

Definition at line 440 of file __init__.py.

kwargs

kwargs

Definition at line 444 of file __init__.py.

Referenced by EditablePartial.__call__(), and EditablePartial.name().

next_action

next_action

Definition at line 467 of file __init__.py.

outcome

outcome

Definition at line 464 of file __init__.py.

Referenced by RetryCallState.__repr__(), RetryCallState.set_exception(), and RetryCallState.set_result().

outcome_timestamp

outcome_timestamp

Definition at line 465 of file __init__.py.

Referenced by RetryCallState.seconds_since_start(), RetryCallState.set_exception(), and RetryCallState.set_result().

retry_object

retry_object

Definition at line 438 of file __init__.py.

start_time

start_time

Definition at line 436 of file __init__.py.

Referenced by Task.elapsed(), Spinner.render(), RetryCallState.seconds_since_start(), Task.speed(), and Task.started().

---

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

• /home/liwuen/projects_dev/pqc-engineering-ssec-23/venv/lib/python3.12/site-packages/pip/_vendor/tenacity/__init__.py