Typing stubs for termcolor

Warnings

• breaking If you are using `termcolor` version 2.0.0 or newer, you should uninstall `types-termcolor`. As of version 2.0.0, the `termcolor` package includes its own inline type annotations, making this stub package redundant and potentially causing conflicts or issues with type checkers.
  Fix: Uninstall `types-termcolor` by running `pip uninstall types-termcolor`. Ensure your type checker is configured to use the inline types from `termcolor`.
• gotcha The `types-termcolor` package provides *only* type stubs; it does not contain the runtime code for the `termcolor` library itself. Your program will not execute correctly without the actual `termcolor` library installed.
  Fix: Ensure the `termcolor` library is installed alongside `types-termcolor` by running `pip install termcolor`.
• gotcha `termcolor` relies on ANSI escape codes to produce colored output in the terminal. Not all terminals (e.g., older Windows Command Prompt or when piping output to certain tools) support these codes, which can result in raw escape sequences being printed instead of the intended colored text.
  Fix: Use a modern terminal emulator (e.g., Windows Terminal, most Linux/macOS terminals, VS Code integrated terminal). When piping output, some tools like `less` may require a `-r` flag to interpret raw ANSI escape sequences (e.g., `python script.py | less -r`).
• gotcha Typeshed stub packages, including `types-termcolor`, use a versioning scheme where parts of the version number correlate to the runtime package's version. While this aims for compatibility, aggressively pinning stub package versions might lead to incompatibilities if the runtime `termcolor` package updates independently, or cause you to miss valuable type stub improvements.
  Fix: Consider using flexible version specifiers for stub packages (e.g., `types-termcolor>=1.1,<1.2` if `termcolor>=1.1,<1.2` is used). Regularly review and update pinned stub versions to leverage improvements and maintain compatibility.

Install

• pip install types-termcolor Install types-termcolor

Imports

• colored

  from termcolor import colored

  The `types-termcolor` package provides type information for symbols imported from the `termcolor` library. You do not directly import from `types-termcolor`.
• cprint

  from termcolor import cprint

  The `types-termcolor` package provides type information for symbols imported from the `termcolor` library. You do not directly import from `types-termcolor`.

Quickstart

This quickstart demonstrates how to use the `colored` function and `cprint` from the `termcolor` library to output text with foreground colors, background highlights, and text attributes to the terminal. When `types-termcolor` is installed, it enables type checkers to provide hints and validate the usage of these functions, improving code quality and readability.

from termcolor import colored, cprint
import sys

# Basic usage of 'colored'
print(colored('Hello, World!', 'red'))

# Using 'colored' with background color and multiple attributes
text_with_attributes = colored(
    "Hello, beautifully colored World!",
    "green",
    "on_red",
    attrs=["bold", "underline"]
)
print(text_with_attributes)

# Using 'cprint' for direct printing
cprint("This is a blue and bold message.", "blue", attrs=["bold"])

# Example with error handling, printing to stderr in red
try:
    raise ValueError("Something went wrong during processing!")
except ValueError as e:
    cprint(f"Error: {e}", "white", "on_red", attrs=["bold"], file=sys.stderr)