Yet another ANSI color text library for Python. Provides "auto colors" for dark/light terminals. Works on Linux, OS X,
and Windows. For Windows support you just need to call Windows.enable() in your application.
On Linux/OS X autocolors are toggled by calling set_light_background() and set_dark_background(). On the
latest version of Windows 10 (after February 2016) it seems like the console finally supports ANSI color codes natively.
In this case you'll just need to call Windows.enable(auto_colors=True, replace_streams=False) to take advantage of
automatically adjusting autocolors to light/dark backgrounds. On previous versions of Windows you'll need to instead
call Windows.enable(auto_colors=True) (replace_streams is True by default) to get colors working. It's ok to leave
replace_streams=True even on the latest version of Windows 10, it's just not necessary.
In Python2.x this library subclasses unicode, while on Python3.x it subclasses str.
- Python 2.6, 2.7, PyPy, PyPy3, 3.3, 3.4, and 3.5 supported on Linux and OS X.
- Python 2.7, 3.3, 3.4, and 3.5 supported on Windows (both 32 and 64 bit versions of Python).
Install:
pip install colorclassIt is possible to pipe curly-bracket tagged (or regular ANSI coded) text to Python in the command line to produce color text. Some examples:
echo "{red}Red{/red}" |python -m colorclass # Red colored text.
echo -e "\033[31mRed\033[0m" | COLOR_DISABLE=true python -m colorclass # Strip colors
echo -e "\033[31mRed\033[0m" | COLOR_ENABLE=true python -m colorclass &> file.txt # Force colors.Export these environment variables as "true" to enable/disable some features:
| Env Variable | Description |
|---|---|
| COLOR_ENABLE | Force colors even when piping to a file. |
| COLOR_DISABLE | Strip all colors from incoming text. |
| COLOR_LIGHT | Use light colored text for dark backgrounds. |
| COLOR_DARK | Use dark colored text for light backgrounds. |
Source code for the example code is: example.py
Different colors are chosen using curly-bracket tags, such as {red}{/red}. For a list of available colors, call
colorclass.list_tags().
The available "auto colors" tags are:
- autoblack
- autored
- autogreen
- autoyellow
- autoblue
- automagenta
- autocyan
- autowhite
- autobgblack
- autobgred
- autobggreen
- autobgyellow
- autobgblue
- autobgmagenta
- autobgcyan
- autobgwhite
Methods of Class instances try to return sane data, such as:
from colorclass import Color
color_string = Color('{red}Test{/red}')
color_string
u'\x1b[31mTest\x1b[39m'
len(color_string)
4
color_string.istitle()
TrueThere are also a couple of helper attributes for all Color instances:
color_string.value_colors
'\x1b[31mTest\x1b[39m'
color_string.value_no_colors
'Test'This project adheres to Semantic Versioning.
- Added
keep_tagsboolean keyword argument to Color(). Prevents colorclass from parsing curly brackets.- Automatically skip replacing stderr/stdout streams on latest Windows 10 versions with native ANSI color support.
- Changed
- Refactored most of windows.py.
- Background color determined from either stderr or stdout, instead of just one stream (e.g. piping stderr to file).
- Fixed
- Added
- Python 3.5 support.
enable_all_colors(),is_enabled(), andis_light()toggle functions.- Library can be used as a script (e.g.
echo "{red}Red{/red}" |python -m colorclass). - Ability to add/multiply Color instances just like str.
- Ability to iterate a Color instance and have each character keep its color codes.
- Changed
- Converted library from Python module to a package.
set_light_background()andset_dark_background()no longer enable colors. Useenable_all_colors().- Colors are disabled by default when STDERR and STDOUT are not streams (piped to files/null). Similar to
grep. - Reduce size of ANSI escape sequences by removing codes that have no effect. e.g.
\033[31;35mto\033[35m. - Color methods that return strings now return Color instances instead of str instances.
- Fixed
- Added
- Convenience single-color methods by Marc Abramowitz.
- Fixed
- Maintaining
Colortype through.encode()and.decode()chains.
- Maintaining
- Fixed
- Python 2.7 64-bit original colors bug on Windows.
- resetting colors when
reset_atexitis True. - Improved sorting of
list_tags().
- Added
- Native Windows support and automatic background colors.
- Added
- Ability to disable/strip out all colors.
- Fixed
splitlines()method.
- Initial release.