IRO

Easy and powerful Colorizer for Python!

Powered by Yamato Nagata

GitHub

The depth represents a block and affects all elements within that block.

from iro import Iro, Color, Style, ColorRGB, Color256

from colorsys import hls_to_rgb

success = Iro((Color.GREEN, "[  SUCCESS ]"))
error = Iro((Color.WHITE, Style.DOUBLY_UNDERLINE, ColorRGB(255, 0, 0, bg=True), "[   ERROR  ]"), disable_rgb=False)
warning = Iro((Color.YELLOW, Color256(255, bg=True), "[  WARNING ]"))
deprecated = Iro((Color256(7), Color256(239, True), Style.STRIKE, "[DEPRECATED]"))

print(success, 'code success.')
print(error, 'code failed!!')
print(warning, 'maybe something wrong.')
print(deprecated, 'this function is deprecated.')

print(Iro([
    Color.RED, "Off course, You can nest styles. ", 
    [
        Style.ITALIC,
        "This is RED and ITALIC. "
    ], 
    [
        Color.BLUE,
        Color.BG_BRIGHT_YELLOW,
        Style.UNDERLINE,
        "This is BLUE, BG_YELLOW and UNDERLINED."
    ],
    " Finally back to only RED!"
]))

for h in range(256):
    print(Iro([ColorRGB(*map(lambda x: x * 255, hls_to_rgb(h / 256, 0.7, 1)), bg=True), ' '], disable_rgb=False), end='')

output

Installation

$ pip install iro

Document

Iro(text: Iterable, disable_rgb: bool = True, optimize_level: int = 0)

• text: Iterable of str, Style, Color, Color256, ColorRGB, Font and Iro.
• disable_rgb: if True, ColorRGB will be converted to similar color of Color256. ColorRGB is not supported in some Terminals.
• optimize_level: 0 or 1. if 0, none of the optimizations will be performed, and each time at the border of the block, a reset and application of all the set styles will be performed. if 1, at the border of the block, only the style that has changed will be modified. However, this may not work correctly for some consoles, and is not recommended if the console being run is unspecified or unknown.

Iro().text to fetch result.

Style

Enum of defined Styling.

RESET
BOLD 
DIM 
ITALIC 
UNDERLINE 
SLOW_BLINK 
RAPID_BLINK 
INVERT 
HIDE 
STRIKE 
BLACKLETTER_FONT 
DOUBLY_UNDERLINE 

OFF_INTENSITY
OFF_BOLD
OFF_DIM
OFF_ITALIC
OFF_UNDERLINE
OFF_BLINK
OFF_INVERT
OFF_HIDE
OFF_STRIKE

OFF_COLOR
OFF_BG_COLOR

OFF_OVERLINE

Note!

OFF_BOLD and OFF_DIM are made for consistency with the Enum to enable styles, which is actually OFF_INTENSITY.
Therefore, OFF_BOLD will also disable DIM.

Color

Enum of 3-bit and 4-bit color.

BLACK 
RED 
GREEN 
YELLOW 
BLUE 
MAGENTA 
CYAN 
WHITE 

BRIGHT_BLACK 
BRIGHT_RED 
BRIGHT_GREEN 
BRIGHT_YELLOW 
BRIGHT_BLUE 
BRIGHT_MAGENTA 
BRIGHT_CYAN 
BRIGHT_WHITE 

BG_BLACK 
BG_RED 
BG_GREEN 
BG_YELLOW 
BG_BLUE 
BG_MAGENTA 
BG_CYAN 
BG_WHITE 

BG_BRIGHT_BLACK 
BG_BRIGHT_RED 
BG_BRIGHT_GREEN 
BG_BRIGHT_YELLOW 
BG_BRIGHT_BLUE 
BG_BRIGHT_MAGENTA 
BG_BRIGHT_CYAN 
BG_BRIGHT_WHITE 

These Colors are supported in almost all of terminals.

In terms of portability, this is how most coloring should be done.

Color256(number: int, bg: bool = False)

• number: number of pre-defined 8-bit color. 0 <= number <= 255
• bg: if True, This color will be applied to background.

ColorRGB(r: int, g: int, b: int, bg: bool = False)

• r, g, b: value of RGB. if float is given, number will be rounded. 0 <= number <= 255
• bg: if True, This color will be applied to background.

ColorRGB.from_color_code(color_code: str, bg: bool = False)

• color_code: str that matches to regex #?[0-9a-fA-F]{6}
• bg: if True, This color will be applied to background.

Font(font_number: int)

• font_number: number of font. 0 is default font. up to 10.

Q&A

My ColorRGB and Color256 is not working!

The problem is most likely caused by the console not supporting it. Please check.

My ColorRGB is not the color that I specified!

If disable_rgb is True, Iro will convert every ColorRGB to similar Color256. Make sure disable_rgb is set to False.

Coloring, Styling and Fonts are not working!

Not all features are supported in every console. Try another one.

Weird string like ･[0m･[0m･[5m･[48;2;168;102;255m ･[0m･[0m･[5m are showing up and not working at all!

Your console is not supporting ANSI escape sequences. Try another console. Or, you can try colorama.
insert this code below in your Script

from colorama import init
init()

How effective is optimization?

ok, Let me show some codes and screenshot.
The two codes below are all the same except for the optimize_level, and the output is equivalent.

value = [
    Color.RED, "[RED]",
    [
        Style.UNDERLINE, "[RED/UNDERLINE]",
        [
            Style.BOLD, Color.GREEN, "[GREEN/UNDERLINE/BOLD]",
            [
                Style.INVERT, "[GREEN/UNDERLINE/BOLD/INVERT]",
                [
                    Style.OFF_BOLD, "[GREEN/UNDERLINE/INVERT]"
                ]
            ],
            "[GREEN/UNDERLINE/BOLD]"
        ],
        "[RED/UNDERLINE]"
    ]
]
print(Iro(value, optimize_level=1))
print(Iro(value, optimize_level=0))

output is below

Now, let's see how optimization worked.

print(repr(Iro(value, optimize_level=1).text))
# '\x1b[31m[RED]\x1b[4m[RED/UNDERLINE]\x1b[1m\x1b[32m[GREEN/UNDERLINE/BOLD]
# \x1b[7m[GREEN/UNDERLINE/BOLD/INVERT]\x1b[22m[GREEN/UNDERLINE/INVERT]
# \x1b[1m\x1b[27m[GREEN/UNDERLINE/BOLD]\x1b[22m\x1b[31m[RED/UNDERLINE]
# \x1b[24m\x1b[39m\x1b[0m'

print(repr(Iro(value, optimize_level=0).text))
# '\x1b[31m[RED]\x1b[31m\x1b[4m[RED/UNDERLINE]\x1b[31m\x1b[4m\x1b[1m\x1b[32m[GREEN/UNDERLINE/BOLD]
# \x1b[31m\x1b[4m\x1b[1m\x1b[32m\x1b[7m[GREEN/UNDERLINE/BOLD/INVERT]
# \x1b[31m\x1b[4m\x1b[1m\x1b[32m\x1b[7m\x1b[22m[GREEN/UNDERLINE/INVERT]
# \x1b[39m\x1b[24m\x1b[22m\x1b[39m\x1b[27m\x1b[22m\x1b[31m\x1b[4m\x1b[1m\x1b[32m\x1b[7m\x1b[39m\x1b
# [24m\x1b[22m\x1b[39m\x1b[27m\x1b[31m\x1b[4m\x1b[1m\x1b[32m[GREEN/UNDERLINE/BOLD]
# \x1b[39m\x1b[24m\x1b[22m\x1b[39m\x1b[31m\x1b[4m[RED/UNDERLINE]
# \x1b[39m\x1b[24m\x1b[31m\x1b[39m\x1b[0m'

This is Huge difference!
Each time the nest depth changes, all previously applied styles will be fully applied in order, even if there is an overriding application. This almost guarantees that it will work, but it is by no means efficient.
On the other hand, if optimize_level is 1, it will try to use escape sequences only when there is a style change.
This is more effective when nesting is deep or when nesting is frequent.