pip._internal.cli.spinners Namespace Reference

Data Structures
class	InteractiveSpinner
class	NonInteractiveSpinner
class	RateLimiter
class	SpinnerInterface

Functions
Generator[SpinnerInterface, None, None]	open_spinner (str message)
Generator[None, None, None]	hidden_cursor (IO[str] file)

Variables
	logger = logging.getLogger(__name__)
str	HIDE_CURSOR = "\x1b[?25l"
str	SHOW_CURSOR = "\x1b[?25h"

Function Documentation

hidden_cursor()

Generator[None, None, None] hidden_cursor

(

IO[str]

file

)

Definition at line 144 of file spinners.py.

def hidden_cursor(file: IO[str]) -> Generator[None, None, None]:
    # The Windows terminal does not support the hide/show cursor ANSI codes,
    # even via colorama. So don't even try.
    if WINDOWS:
        yield
    # We don't want to clutter the output with control characters if we're
    # writing to a file, or if the user is running with --quiet.
    # See https://github.com/pypa/pip/issues/3418
    elif not file.isatty() or logger.getEffectiveLevel() > logging.INFO:
        yield
    else:
        file.write(HIDE_CURSOR)
        try:
            yield
        finally:
            file.write(SHOW_CURSOR)

References i.

Referenced by pip._internal.cli.spinners.open_spinner().

Here is the caller graph for this function:

open_spinner()

Generator[SpinnerInterface, None, None] open_spinner

(

str

message

)

Definition at line 116 of file spinners.py.

def open_spinner(message: str) -> Generator[SpinnerInterface, None, None]:
    # Interactive spinner goes directly to sys.stdout rather than being routed
    # through the logging system, but it acts like it has level INFO,
    # i.e. it's only displayed if we're at level INFO or better.
    # Non-interactive spinner goes through the logging system, so it is always
    # in sync with logging configuration.
    if sys.stdout.isatty() and logger.getEffectiveLevel() <= logging.INFO:
        spinner: SpinnerInterface = InteractiveSpinner(message)
    else:
        spinner = NonInteractiveSpinner(message)
    try:
        with hidden_cursor(sys.stdout):
            yield spinner
    except KeyboardInterrupt:
        spinner.finish("canceled")
        raise
    except Exception:
        spinner.finish("error")
        raise
    else:
        spinner.finish("done")
 
 

References pip._internal.cli.spinners.hidden_cursor(), and i.

Here is the call graph for this function:

Variable Documentation

HIDE_CURSOR

str HIDE_CURSOR = "\x1b[?25l"

Definition at line 139 of file spinners.py.

logger

logger = logging.getLogger(__name__)

Definition at line 11 of file spinners.py.

SHOW_CURSOR

str SHOW_CURSOR = "\x1b[?25h"

Definition at line 140 of file spinners.py.