Name already in use
If nothing happens, download GitHub Desktop and try again.
Launching GitHub Desktop
If nothing happens, download GitHub Desktop and try again.
Launching Xcode
If nothing happens, download Xcode and try again.
Launching Visual Studio Code
Your codespace will open once ready.
There was a problem preparing your codespace, please try again.
Latest commit
Git stats
Files
Failed to load latest commit information.
README.rst
Makes ANSI escape character sequences (for producing colored terminal text and cursor positioning) work under MS Windows.
If you find Colorama useful, please to the authors. Thank you!
Tested on CPython 2.7, 3.7, 3.8, 3.9, 3.10 and 3.11 and PyPy 2.7 and 3.8.
No requirements other than the standard library.
ANSI escape character sequences have long been used to produce colored terminal text and cursor positioning on Unix and Macs. Colorama makes this work on Windows, too, by wrapping stdout , stripping ANSI sequences it finds (which would appear as gobbledygook in the output), and converting them into the appropriate win32 calls to modify the state of the terminal. On other platforms, Colorama does nothing.
This has the upshot of providing a simple cross-platform API for printing colored terminal text from Python, and has the happy side-effect that existing applications or libraries which use ANSI sequences to produce colored output on Linux or Macs can now also work on Windows, simply by calling colorama.just_fix_windows_console() (since v0.4.6) or colorama.init() (all versions, but may have other side-effects – see below).
An alternative approach is to install ansi.sys on Windows machines, which provides the same behaviour for all applications running in terminals. Colorama is intended for situations where that isn’t easy (e.g., maybe your app doesn’t have an installer.)
Demo scripts in the source code repository print some colored text using ANSI sequences. Compare their output under Gnome-terminal’s built in ANSI handling, versus on Windows Command-Prompt using Colorama:
These screenshots show that, on Windows, Colorama does not support ANSI ‘dim text’; it looks the same as ‘normal text’.
If the only thing you want from Colorama is to get ANSI escapes to work on Windows, then run:
If you’re on a recent version of Windows 10 or better, and your stdout/stderr are pointing to a Windows console, then this will flip the magic configuration switch to enable Windows’ built-in ANSI support.
If you’re on an older version of Windows, and your stdout/stderr are pointing to a Windows console, then this will wrap sys.stdout and/or sys.stderr in a magic file object that intercepts ANSI escape sequences and issues the appropriate Win32 calls to emulate them.
In all other circumstances, it does nothing whatsoever. Basically the idea is that this makes Windows act like Unix with respect to ANSI escape handling.
It’s safe to call this function multiple times. It’s safe to call this function on non-Windows platforms, but it won’t do anything. It’s safe to call this function when one or both of your stdout/stderr are redirected to a file – it won’t do anything to those streams.
Alternatively, you can use the older interface with more features (but also more potential footguns):
This does the same thing as just_fix_windows_console , except for the following differences:
- It’s not safe to call init multiple times; you can end up with multiple layers of wrapping and broken ANSI support.
- Colorama will apply a heuristic to guess whether stdout/stderr support ANSI, and if it thinks they don’t, then it will wrap sys.stdout and sys.stderr in a magic file object that strips out ANSI escape sequences before printing them. This happens on all platforms, and can be convenient if you want to write your code to emit ANSI escape sequences unconditionally, and let Colorama decide whether they should actually be output. But note that Colorama’s heuristic is not particularly clever.
- init also accepts explicit keyword args to enable/disable various functionality – see below.
To stop using Colorama before your program exits, simply call deinit() . This will restore stdout and stderr to their original values, so that Colorama is disabled. To resume using Colorama again, call reinit() ; it is cheaper than calling init() again (but does the same thing).
Most users should depend on colorama >= 0.4.6 , and use just_fix_windows_console . The old init interface will be supported indefinitely for backwards compatibility, but we don’t plan to fix any issues with it, also for backwards compatibility.
Cross-platform printing of colored text can then be done using Colorama’s constant shorthand for ANSI escape sequences. These are deliberately rudimentary, see below.
. or simply by manually printing ANSI sequences from your own code:
. or, Colorama can be used in conjunction with existing ANSI libraries such as the venerable Termcolor the fabulous Blessings, or the incredible _Rich.
If you wish Colorama’s Fore, Back and Style constants were more capable, then consider using one of the above highly capable libraries to generate colors, etc, and use Colorama just for its primary purpose: to convert those ANSI sequences to also work on Windows:
SIMILARLY, do not send PRs adding the generation of new ANSI types to Colorama. We are only interested in converting ANSI codes to win32 API calls, not shortcuts like the above to generate ANSI characters.
Available formatting constants are:
Style.RESET_ALL resets foreground, background, and brightness. Colorama will perform this reset automatically on program exit.
These are fairly well supported, but not part of the standard:
ANSI codes to reposition the cursor are supported. See demos/demo06.py for an example of how to generate them.
Init Keyword Args
init() accepts some **kwargs to override default behaviour.
If you find yourself repeatedly sending reset sequences to turn off color changes at the end of every print, then init(autoreset=True) will automate that:
On Windows, Colorama works by replacing sys.stdout and sys.stderr with proxy objects, which override the .write() method to do their work. If this wrapping causes you problems, then this can be disabled by passing init(wrap=False) . The default behaviour is to wrap if autoreset or strip or convert are True.
When wrapping is disabled, colored printing on non-Windows platforms will continue to work as normal. To do cross-platform colored output, you can use Colorama’s AnsiToWin32 proxy directly:
Recognised ANSI Sequences
ANSI sequences generally take the form:
Where <param> is an integer, and <command> is a single letter. Zero or more params are passed to a <command> . If no params are passed, it is generally synonymous with passing a single zero. No spaces exist in the sequence; they have been inserted here simply to read more easily.
The only ANSI sequences that Colorama converts into win32 calls are:
Multiple numeric params to the ‘m’ command can be combined into a single sequence:
All other ANSI sequences of the form ESC [ <param> ; <param> . <command> are silently stripped from the output on Windows.
Any other form of ANSI sequence, such as single-character codes or alternative initial characters, are not recognised or stripped. It would be cool to add them though. Let me know if it would be useful for you, via the Issues on GitHub.
Status & Known Problems
I’ve personally only tested it on Windows XP (CMD, Console2), Ubuntu (gnome-terminal, xterm), and OS X.
Some valid ANSI sequences aren’t recognised.
If you’re hacking on the code, see README-hacking.md. ESPECIALLY, see the explanation there of why we do not want PRs that allow Colorama to generate new types of ANSI codes.
If anything doesn’t work for you, or doesn’t do what you expected or hoped for, I’d love to hear about it on that issues list, would be delighted by patches, and would be happy to grant commit access to anyone who submits a working patch or two.
Copyright Jonathan Hartley & Arnon Yaari, 2013-2020. BSD 3-Clause license; see LICENSE file.
colorama 0.4.6
Makes ANSI escape character sequences (for producing colored terminal text and cursor positioning) work under MS Windows.
If you find Colorama useful, please to the authors. Thank you!
Installation
Tested on CPython 2.7, 3.7, 3.8, 3.9 and 3.10 and Pypy 2.7 and 3.8.
No requirements other than the standard library.
Description
ANSI escape character sequences have long been used to produce colored terminal text and cursor positioning on Unix and Macs. Colorama makes this work on Windows, too, by wrapping stdout , stripping ANSI sequences it finds (which would appear as gobbledygook in the output), and converting them into the appropriate win32 calls to modify the state of the terminal. On other platforms, Colorama does nothing.
This has the upshot of providing a simple cross-platform API for printing colored terminal text from Python, and has the happy side-effect that existing applications or libraries which use ANSI sequences to produce colored output on Linux or Macs can now also work on Windows, simply by calling colorama.just_fix_windows_console() (since v0.4.6) or colorama.init() (all versions, but may have other side-effects – see below).
An alternative approach is to install ansi.sys on Windows machines, which provides the same behaviour for all applications running in terminals. Colorama is intended for situations where that isn’t easy (e.g., maybe your app doesn’t have an installer.)
Demo scripts in the source code repository print some colored text using ANSI sequences. Compare their output under Gnome-terminal’s built in ANSI handling, versus on Windows Command-Prompt using Colorama:
These screenshots show that, on Windows, Colorama does not support ANSI ‘dim text’; it looks the same as ‘normal text’.
Usage
Initialisation
If the only thing you want from Colorama is to get ANSI escapes to work on Windows, then run:
If you’re on a recent version of Windows 10 or better, and your stdout/stderr are pointing to a Windows console, then this will flip the magic configuration switch to enable Windows’ built-in ANSI support.
If you’re on an older version of Windows, and your stdout/stderr are pointing to a Windows console, then this will wrap sys.stdout and/or sys.stderr in a magic file object that intercepts ANSI escape sequences and issues the appropriate Win32 calls to emulate them.
In all other circumstances, it does nothing whatsoever. Basically the idea is that this makes Windows act like Unix with respect to ANSI escape handling.
It’s safe to call this function multiple times. It’s safe to call this function on non-Windows platforms, but it won’t do anything. It’s safe to call this function when one or both of your stdout/stderr are redirected to a file – it won’t do anything to those streams.
Alternatively, you can use the older interface with more features (but also more potential footguns):
This does the same thing as just_fix_windows_console , except for the following differences:
To stop using Colorama before your program exits, simply call deinit() . This will restore stdout and stderr to their original values, so that Colorama is disabled. To resume using Colorama again, call reinit() ; it is cheaper than calling init() again (but does the same thing).
Most users should depend on colorama >= 0.4.6 , and use just_fix_windows_console . The old init interface will be supported indefinitely for backwards compatibility, but we don’t plan to fix any issues with it, also for backwards compatibility.
Colored Output
Cross-platform printing of colored text can then be done using Colorama’s constant shorthand for ANSI escape sequences. These are deliberately rudimentary, see below.
…or simply by manually printing ANSI sequences from your own code:
…or, Colorama can be used in conjunction with existing ANSI libraries such as the venerable Termcolor the fabulous Blessings, or the incredible _Rich.
If you wish Colorama’s Fore, Back and Style constants were more capable, then consider using one of the above highly capable libraries to generate colors, etc, and use Colorama just for its primary purpose: to convert those ANSI sequences to also work on Windows:
SIMILARLY, do not send PRs adding the generation of new ANSI types to Colorama. We are only interested in converting ANSI codes to win32 API calls, not shortcuts like the above to generate ANSI characters.
Available formatting constants are:
Style.RESET_ALL resets foreground, background, and brightness. Colorama will perform this reset automatically on program exit.
These are fairly well supported, but not part of the standard:
Cursor Positioning
ANSI codes to reposition the cursor are supported. See demos/demo06.py for an example of how to generate them.
Init Keyword Args
init() accepts some **kwargs to override default behaviour.
If you find yourself repeatedly sending reset sequences to turn off color changes at the end of every print, then init(autoreset=True) will automate that:
Pass True or False to override whether ANSI codes should be stripped from the output. The default behaviour is to strip if on Windows or if output is redirected (not a tty).
Pass True or False to override whether to convert ANSI codes in the output into win32 calls. The default behaviour is to convert if on Windows and output is to a tty (terminal).
On Windows, Colorama works by replacing sys.stdout and sys.stderr with proxy objects, which override the .write() method to do their work. If this wrapping causes you problems, then this can be disabled by passing init(wrap=False) . The default behaviour is to wrap if autoreset or strip or convert are True.
When wrapping is disabled, colored printing on non-Windows platforms will continue to work as normal. To do cross-platform colored output, you can use Colorama’s AnsiToWin32 proxy directly:
Recognised ANSI Sequences
ANSI sequences generally take the form:
Where <param> is an integer, and <command> is a single letter. Zero or more params are passed to a <command> . If no params are passed, it is generally synonymous with passing a single zero. No spaces exist in the sequence; they have been inserted here simply to read more easily.
The only ANSI sequences that Colorama converts into win32 calls are:
Multiple numeric params to the ‘m’ command can be combined into a single sequence:
All other ANSI sequences of the form ESC [ <param> ; <param> . <command> are silently stripped from the output on Windows.
Any other form of ANSI sequence, such as single-character codes or alternative initial characters, are not recognised or stripped. It would be cool to add them though. Let me know if it would be useful for you, via the Issues on GitHub.
Status & Known Problems
I’ve personally only tested it on Windows XP (CMD, Console2), Ubuntu (gnome-terminal, xterm), and OS X.
Some valid ANSI sequences aren’t recognised.
If you’re hacking on the code, see README-hacking.md. ESPECIALLY, see the explanation there of why we do not want PRs that allow Colorama to generate new types of ANSI codes.
If anything doesn’t work for you, or doesn’t do what you expected or hoped for, I’d love to hear about it on that issues list, would be delighted by patches, and would be happy to grant commit access to anyone who submits a working patch or two.
License
Copyright Jonathan Hartley & Arnon Yaari, 2013-2020. BSD 3-Clause license; see LICENSE file.
Get Colored Console Output In Python Using Colorama
In this blog I am gonna talk about a python module that can make your console based applications look much better than they normally look, the colorama module.
Here’s how a normal console application looks without using colorama.
And here’s how the same script would look with some color effects.
Isn’t that beautiful .
All of this was possible due to colorama module. And we are gonna learn how we can use this module in python.
About The Module
Colorama is a python module that is used to display colored output in console. It can change both, foreground and background color of any text which is displayed in the console.
The link to its github repository is this:
colorama.
Getting Started With Colorama
First you need to download and install colorama. Just open your command prompt and type the following:
How to install Colorama in Python?
I copied and pasted the folder under ‘C:\Python26\Lib\site-packages’ and tried to run the setup from there. Same deal. Am I doing something wrong?
11 Answers 11
Installing with pip is almost always the way to go. It will handle downloading the package for you, as well as any dependencies. If you don’t have pip, see http://www.pip-installer.org/en/latest/installing.html
Python packages are installed using setup.py by entering the following command from a command line:
I just a weird problem with awscli and colorama . Searching for an answer, I came here. The solution was:
Run the following command in Google shell:
sudo pip3 install colorama
if you have easy_install (in most case that will work)
if you installed pip
Re-installing colorama might not work right away. If there is a colorama .egg in site-packages , you need to remove that file first and then pip install colorama .
I have also experienced this problem. Following the instructions to install sudo pip install colorama I receive the message:
Requirement already satisfied: colorama in /usr/lib/python2.7/dist-packages.
The problem for me is that I am using python3 in my header code #!usr/bin/env python3 . Changing this to #!usr/bin/env python works — sorry, I don’t know how to get it to work with python 3!