InteractiveSpinner Class Reference

Inheritance diagram for InteractiveSpinner:

Collaboration diagram for InteractiveSpinner:

Public Member Functions
	__init__ (self, str message, Optional[IO[str]] file=None, str spin_chars="-\\|/", float min_update_interval_seconds=0.125)
None	spin (self)
None	finish (self, str final_status)

Protected Member Functions
None	_write (self, str status)

Protected Attributes
	_message
	_file
	_rate_limiter
	_finished
	_spin_cycle
	_width

Detailed Description

Definition at line 22 of file spinners.py.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
		str	message,
		Optional[IO[str]]	file = None,
		str	spin_chars = "-\\|/",
		float	min_update_interval_seconds = 0.125
	)

Definition at line 23 of file spinners.py.

    ):
        self._message = message
        if file is None:
            file = sys.stdout
        self._file = file
        self._rate_limiter = RateLimiter(min_update_interval_seconds)
        self._finished = False
 
        self._spin_cycle = itertools.cycle(spin_chars)
 
        self._file.write(" " * get_indentation() + self._message + " ... ")
        self._width = 0
 

Referenced by Protocol.__init_subclass__().

Here is the caller graph for this function:

Member Function Documentation

_write()

None _write (   self, str  status  )

protected

Definition at line 43 of file spinners.py.

    def _write(self, status: str) -> None:
        assert not self._finished
        # Erase what we wrote before by backspacing to the beginning, writing
        # spaces to overwrite the old text, and then backspacing again
        backup = "\b" * self._width
        self._file.write(backup + " " * self._width + backup)
        # Now we have a blank slate to add our status
        self._file.write(status)
        self._width = len(status)
        self._file.flush()
        self._rate_limiter.reset()
 

References InteractiveSpinner._file, LazyZipOverHTTP._file, ScriptFile._file, LegacyWindowsTerm._file, Console._file, InteractiveSpinner._finished, NonInteractiveSpinner._finished, InteractiveSpinner._rate_limiter, NonInteractiveSpinner._rate_limiter, InteractiveSpinner._width, Console._width, and i.

Referenced by InteractiveSpinner.finish(), _FileCacheMixin.set(), SeparateBodyFileCache.set_body(), and InteractiveSpinner.spin().

Here is the caller graph for this function:

finish()

None finish	(		self,
		str	final_status
	)

Reimplemented from SpinnerInterface.

Definition at line 62 of file spinners.py.

    def finish(self, final_status: str) -> None:
        if self._finished:
            return
        self._write(final_status)
        self._file.write("\n")
        self._file.flush()
        self._finished = True
 
 
# Used for dumb terminals, non-interactive installs (no tty), etc.
# We still print updates occasionally (once every 60 seconds by default) to
# act as a keep-alive for systems like Travis-CI that take lack-of-output as
# an indication that a task has frozen.

References InteractiveSpinner._file, LazyZipOverHTTP._file, ScriptFile._file, LegacyWindowsTerm._file, Console._file, InteractiveSpinner._finished, NonInteractiveSpinner._finished, _FileCacheMixin._write(), and InteractiveSpinner._write().

Here is the call graph for this function:

spin()

None spin

(

self

)

Reimplemented from SpinnerInterface.

Definition at line 55 of file spinners.py.

    def spin(self) -> None:
        if self._finished:
            return
        if not self._rate_limiter.ready():
            return
        self._write(next(self._spin_cycle))
 

References InteractiveSpinner._finished, NonInteractiveSpinner._finished, InteractiveSpinner._rate_limiter, NonInteractiveSpinner._rate_limiter, InteractiveSpinner._spin_cycle, _FileCacheMixin._write(), and InteractiveSpinner._write().

Here is the call graph for this function:

Field Documentation

_file

_file

protected

Definition at line 34 of file spinners.py.

Referenced by LazyZipOverHTTP.__enter__(), LazyZipOverHTTP.__exit__(), LazyZipOverHTTP._download(), InteractiveSpinner._write(), LazyZipOverHTTP.close(), LazyZipOverHTTP.closed(), Console.file(), Console.file(), InteractiveSpinner.finish(), LazyZipOverHTTP.name(), LazyZipOverHTTP.read(), ScriptFile.save(), LazyZipOverHTTP.seek(), LazyZipOverHTTP.tell(), and LazyZipOverHTTP.truncate().

_finished

_finished

protected

Definition at line 36 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 31 of file spinners.py.

Referenced by NonInteractiveSpinner._update().

_rate_limiter

_rate_limiter

protected

Definition at line 35 of file spinners.py.

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

_spin_cycle

_spin_cycle

protected

Definition at line 38 of file spinners.py.

Referenced by InteractiveSpinner.spin().

_width

_width

protected

Definition at line 41 of file spinners.py.

Referenced by InteractiveSpinner._write(), Console.size(), Console.size(), and Console.width().

---

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