Nothing Special   »   [go: up one dir, main page]

Skip to main content
Warning Some features may not work without JavaScript. Please try enabling it if you encounter problems.

ANSI color formatting for output in terminal

Project description

termcolor

PyPI version Supported Python versions PyPI downloads GitHub Actions status Codecov Licence Code style: Black Tidelift

Installation

From PyPI

python3 -m pip install --upgrade termcolor

From source

git clone https://github.com/termcolor/termcolor
cd termcolor
python3 -m pip install .

Demo

To see demo output, run:

python3 -m termcolor

Example

import sys

from termcolor import colored, cprint

text = colored("Hello, World!", "red", attrs=["reverse", "blink"])
print(text)
cprint("Hello, World!", "green", "on_red")

print_red_on_cyan = lambda x: cprint(x, "red", "on_cyan")
print_red_on_cyan("Hello, World!")
print_red_on_cyan("Hello, Universe!")

for i in range(10):
    cprint(i, "magenta", end=" ")

cprint("Attention!", "red", attrs=["bold"], file=sys.stderr)

Text properties

Text colors Text highlights Attributes
black on_black bold
red on_red dark
green on_green underline
yellow on_yellow blink
blue on_blue reverse
magenta on_magenta concealed
cyan on_cyan strike
white on_white
light_grey on_light_grey
dark_grey on_dark_grey
light_red on_light_red
light_green on_light_green
light_yellow on_light_yellow
light_blue on_light_blue
light_magenta on_light_magenta
light_cyan on_light_cyan

Terminal properties

Terminal bold dark underline blink reverse concealed
xterm yes no yes bold yes yes
linux yes yes bold yes yes no
rxvt yes no yes bold/black yes no
dtterm yes yes yes reverse yes yes
teraterm reverse no yes rev/red yes no
aixterm normal no yes no yes yes
PuTTY color no yes no yes no
Windows no no no no yes no
Cygwin SSH yes no color color color yes
Mac Terminal yes no yes yes yes yes

Overrides

Terminal colour detection can be disabled or enabled in several ways.

In order of precedence:

  1. Calling colored or cprint with a truthy no_color disables colour.
  2. Calling colored or cprint with a truthy force_color forces colour.
  3. Setting the ANSI_COLORS_DISABLED environment variable to any value disables colour.
  4. Setting the NO_COLOR environment variable to any value disables colour.
  5. Setting the FORCE_COLOR environment variable to any value forces colour.
  6. Setting the TERM environment variable to dumb, or using such a dumb terminal, disables colour.
  7. Finally, termcolor will attempt to detect whether the terminal supports colour.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

termcolor-2.5.0.tar.gz (13.1 kB view details)

Uploaded Source

Built Distribution

termcolor-2.5.0-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

Details for the file termcolor-2.5.0.tar.gz.

File metadata

  • Download URL: termcolor-2.5.0.tar.gz
  • Upload date:
  • Size: 13.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for termcolor-2.5.0.tar.gz
Algorithm Hash digest
SHA256 998d8d27da6d48442e8e1f016119076b690d962507531df4890fcd2db2ef8a6f
MD5 26f496075070852b5d39762bbd14ec46
BLAKE2b-256 377288311445fd44c455c7d553e61f95412cf89054308a1aa2434ab835075fc5

See more details on using hashes here.

Provenance

The following attestation bundles were made for termcolor-2.5.0.tar.gz:

Publisher: deploy.yml on termcolor/termcolor

Attestations:

File details

Details for the file termcolor-2.5.0-py3-none-any.whl.

File metadata

  • Download URL: termcolor-2.5.0-py3-none-any.whl
  • Upload date:
  • Size: 7.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for termcolor-2.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 37b17b5fc1e604945c2642c872a3764b5d547a48009871aea3edd3afa180afb8
MD5 a7f44cd6975ff6cd5e052fa2616c2c22
BLAKE2b-256 7fbedf630c387a0a054815d60be6a97eb4e8f17385d5d6fe660e1c02750062b4

See more details on using hashes here.

Provenance

The following attestation bundles were made for termcolor-2.5.0-py3-none-any.whl:

Publisher: deploy.yml on termcolor/termcolor

Attestations:

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page