Rich

Warnings

• breaking v14.0.0 changed how NO_COLOR and FORCE_COLOR are interpreted: an empty string value for either env var is now treated as disabled (falsy), not enabled. Code or CI configs that set NO_COLOR= or FORCE_COLOR= (empty) to toggle color will behave differently.
  Fix: Set NO_COLOR=1 or FORCE_COLOR=1 (non-empty) to explicitly enable/disable color. For CI without a TTY, set TTY_COMPATIBLE=1 and TTY_INTERACTIVE=0 instead of relying on FORCE_COLOR.
• gotcha Square brackets in printed strings are parsed as markup tags. Printing user-supplied or dynamic data containing brackets (e.g. log messages, file paths, regex patterns) can silently swallow content or raise MarkupError.
  Fix: Wrap untrusted strings with `from rich.markup import escape` before embedding in f-strings, or pass markup=False to console.print().
• gotcha RichHandler does not enable Console Markup in log messages by default (markup=False). Enabling markup=True on the handler is unsafe if any dependency logs strings containing square brackets.
  Fix: Leave markup=False (default) for shared loggers. Pass extra={'markup': True} per-record only for log calls you fully control.
• gotcha Rich never automatically installs its traceback handler. If you see Rich-style tracebacks unexpectedly, a third-party library is calling rich.traceback.install() — not Rich itself.
  Fix: Call `from rich.traceback import install; install()` explicitly in your own entry point if you want Rich tracebacks.
• gotcha Progress (and Live) cannot be nested prior to v14.1.0. Using a progress bar inside another Progress or Live context (e.g. inside a status spinner) raised a RuntimeError.
  Fix: Upgrade to >=14.1.0. On older versions, flatten nested progress into a single Progress instance with multiple tasks.
• gotcha In CI/GitHub Actions, Rich outputs plain text because the environment is not a TTY. Setting FORCE_COLOR= (empty) no longer forces color in v14+.
  Fix: Set TTY_COMPATIBLE=1 and TTY_INTERACTIVE=0 in the CI environment to get ANSI output without interactive animations.
• deprecated RenderGroup and render_group were renamed to Group and group in an earlier release. The old names were kept for compatibility but are slated for removal.
  Fix: Use `from rich.console import Group` and `from rich.console import group` instead of the RenderGroup equivalents.

Install

• pip install rich pip
• uv add rich uv

Imports

• Console

  from rich.console import Console

  Console lives in rich.console, not the top-level rich namespace
• print

  from rich import print

  Drop-in replacement for built-in print; shadowing builtins is intentional here
• Table

  from rich.table import Table

  Table and Column are both in rich.table
• Progress / track

  from rich.progress import Progress, track

  Simple iteration: use track(); full control: use Progress as a context manager
• RichHandler

  from rich.logging import RichHandler

  Pass to logging.basicConfig handlers=[RichHandler()] to integrate with stdlib logging
• Syntax

  from rich.syntax import Syntax

  Requires pygments; pass language string and optional theme/line_numbers kwargs
• Markdown

  from rich.markdown import Markdown

  Pass rendered Markdown instance to console.print(), not a raw string
• Traceback install

  from rich.traceback import install; install()

  Must be called explicitly; Rich never installs its traceback handler automatically
• escape

  from rich.markup import escape

  Use to sanitize user-supplied strings before embedding in f-string markup
• Live

  from rich.live import Live

  Live objects may be nested as of v14.1.0; previously nesting Progress raised an error

Quickstart

Demonstrate Console, markup, Table, Progress, RichHandler, and Syntax in one runnable script.

import logging
import time

from rich.console import Console
from rich.logging import RichHandler
from rich.markup import escape
from rich.progress import track
from rich.syntax import Syntax
from rich.table import Table

# -- Console & markup --
console = Console()
console.print("[bold magenta]Rich[/bold magenta] is working! :tada:")

# -- Safe interpolation of untrusted strings --
user_input = "[blink]injected[/blink]"
console.print(f"Hello, {escape(user_input)}!")

# -- Table --
table = Table(title="Languages")
table.add_column("Name", style="cyan")
table.add_column("Paradigm", style="green")
table.add_row("Python", "Multi-paradigm")
table.add_row("Haskell", "Functional")
console.print(table)

# -- Syntax highlighting --
code = "def greet(name):\n    return f'Hello, {name}!'"
syntax = Syntax(code, "python", theme="monokai", line_numbers=True)
console.print(syntax)

# -- Progress bar --
for _ in track(range(5), description="Processing..."):
    time.sleep(0.1)

# -- stdlib logging integration --
logging.basicConfig(
    level="INFO",
    format="%(message)s",
    datefmt="[%X]",
    handlers=[RichHandler()],
)
log = logging.getLogger("rich")
log.info("All done.")