Halo

Warnings

• deprecated The library internally uses `threading.Thread.setDaemon`, which has been deprecated in Python 3.10 in favor of setting the `daemon` attribute directly. This may lead to deprecation warnings or unexpected behavior in newer Python environments.
  Fix: No direct fix for users; requires library update. Monitor GitHub issues for resolution.
• breaking There is an open bug where using text animations and then switching to a new message that is shorter than the current animated text can cause a crash.
  Fix: Avoid changing animated text to a significantly shorter string, or ensure animations are stopped before text changes, particularly if crashes are observed.
• gotcha On Windows operating systems, the default spinner might be 'line' instead of the commonly shown 'dots' spinner due to terminal compatibility. Users should explicitly specify `spinner='dots'` if they want that animation on Windows.
  Fix: Initialize `Halo` with `spinner='dots'` (or another desired spinner) explicitly: `Halo(..., spinner='dots')`.
• gotcha Text provided to the `Halo` spinner may incorrectly ignore leading spaces, which can affect precise formatting and alignment in the terminal.
  Fix: If leading spaces are critical, consider pre-padding the terminal output or using alternative methods for alignment rather than relying on `Halo`'s text parameter for leading spaces.
• gotcha Halo spinners may not render correctly or appear at all in certain continuous integration (CI/CD) environments, such as Jenkins, due to terminal emulation differences.
  Fix: Test terminal output in your specific CI environment. Consider disabling spinners (`enabled=False`) in CI environments if display issues occur, or check for CI-specific configuration options.

Install

• pip install halo Install stable version

Imports

• Halo

  from halo import Halo

Quickstart

The `Halo` class is the primary interface for creating and managing terminal spinners. It can be used directly with `start()` and `stop()` methods, as a context manager (using `with` statement), or as a decorator. The context manager approach is generally recommended for clean resource management.

import time
from halo import Halo

# Basic usage with a 'with' statement for automatic start/stop and cleanup
with Halo(text='Loading data...', spinner='dots', color='cyan') as spinner:
    time.sleep(2) # Simulate a long-running operation
    spinner.succeed('Data loaded successfully!')

print("Application continues...")