NonInteractiveSpinner Class Reference

Inheritance diagram for NonInteractiveSpinner:

Collaboration diagram for NonInteractiveSpinner:

Public Member Functions
None	__init__ (self, str message, float min_update_interval_seconds=60.0)
None	spin (self)
None	finish (self, str final_status)

Protected Member Functions
None	_update (self, str status)

Protected Attributes
	_message
	_finished
	_rate_limiter

Detailed Description

Definition at line 75 of file spinners.py.

Constructor & Destructor Documentation

__init__()

None __init__	(		self,
		str	message,
		float	min_update_interval_seconds = 60.0
	)

Definition at line 76 of file spinners.py.

    def __init__(self, message: str, min_update_interval_seconds: float = 60.0) -> None:
        self._message = message
        self._finished = False
        self._rate_limiter = RateLimiter(min_update_interval_seconds)
        self._update("started")
 

Referenced by Protocol.__init_subclass__().

Here is the caller graph for this function:

Member Function Documentation

_update()

None _update (   self, str  status  )

protected

Definition at line 82 of file spinners.py.

    def _update(self, status: str) -> None:
        assert not self._finished
        self._rate_limiter.reset()
        logger.info("%s: %s", self._message, status)
 

References InteractiveSpinner._finished, NonInteractiveSpinner._finished, InteractiveSpinner._message, NonInteractiveSpinner._message, InteractiveSpinner._rate_limiter, NonInteractiveSpinner._rate_limiter, and i.

Referenced by NonInteractiveSpinner.finish(), and NonInteractiveSpinner.spin().

Here is the caller graph for this function:

finish()

None finish	(		self,
		str	final_status
	)

Reimplemented from SpinnerInterface.

Definition at line 94 of file spinners.py.

    def finish(self, final_status: str) -> None:
        if self._finished:
            return
        self._update(f"finished with status '{final_status}'")
        self._finished = True
 
 

References InteractiveSpinner._finished, NonInteractiveSpinner._finished, and NonInteractiveSpinner._update().

Here is the call graph for this function:

spin()

None spin

(

self

)

Reimplemented from SpinnerInterface.

Definition at line 87 of file spinners.py.

    def spin(self) -> None:
        if self._finished:
            return
        if not self._rate_limiter.ready():
            return
        self._update("still running...")
 

References InteractiveSpinner._finished, NonInteractiveSpinner._finished, InteractiveSpinner._rate_limiter, NonInteractiveSpinner._rate_limiter, and NonInteractiveSpinner._update().

Here is the call graph for this function:

Field Documentation

_finished

_finished

protected

Definition at line 78 of file spinners.py.

Referenced by NonInteractiveSpinner._update(), InteractiveSpinner._write(), InteractiveSpinner.finish(), NonInteractiveSpinner.finish(), InteractiveSpinner.spin(), and NonInteractiveSpinner.spin().

_message

_message

protected

Definition at line 77 of file spinners.py.

Referenced by NonInteractiveSpinner._update().

_rate_limiter

_rate_limiter

protected

Definition at line 79 of file spinners.py.

Referenced by NonInteractiveSpinner._update(), InteractiveSpinner._write(), InteractiveSpinner.spin(), and NonInteractiveSpinner.spin().

---

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/_internal/cli/spinners.py