colorfulstring 0.0.3

Make colorful strings.

colorfulstring

colorfulstring is a lightweight Python utility for building ANSI-colored terminal strings with a fluent, chainable API.

Installation

pip install colorfulstring

Quick Start

from colorfulstring import c

print(c.r << "Error:" << " something went wrong")
print(c.g("OK"))

Usage

1) Color Shortcuts

Available shortcut color properties are d/r/g/y/b/p/c/w (dark/red/green/yellow/blue/purple/cyan/white).

You can chain them for background presets, e.g. c.b.g means blue foreground + green background.

Chaining is limited to two colors; c.b.g.g is not allowed.

print(c.y << "Warning")
print(c.b.g << "Blue on green via chaining")

2) Pipe-Style Chaining

Use << (or @) to append fragments in sequence:

print(c.b << "[INFO]" << " service started")

3) Conditional Output

• iftrue(condition): include the next fragment only when condition is True.
• ifnot(condition): include the next fragment only when condition is False.
• ifelse(condition): choose between the next two fragments.

ok = True
line = c << "status: " << c.ifelse(ok) << c.g("success") << c.r("failed")
print(line)

4) Immediate Printing

c.print outputs each generated fragment immediately (without an automatic newline). It can be combined with c.endl.

line = c.print << "hello" << c.endl

5) Underline

Use .underline to add underline style:

print(c.underline << "plain underline")
print(c.underline.g << "green underline")
print(c.underline.g.b << "green on blue underline")

6) Faint Foreground

Use .faint to switch the foreground to a faint ANSI variant. It must follow the foreground color token.

print(c.r.faint << "faint red")
print(c.g.faint.b << "faint green on blue")

Note:

• c.faint is no different from c, if you need a faint dark color, try c.d.faint.

7) Inline Token Grammar

Besides fluent chaining, colorfulstring can also parse inline token fragments from plain strings:

print(c("$R:error$"))
print(c("$G-.B:faint green on blue$"))
print(c("$_Y:underlined yellow$"))

Grammar (inside $...$):

• TOKEN:text
• TOKEN:
  • FG (foreground), e.g. R, G, B
  • FG- (faint foreground)
  • FG.BG (foreground + background)
  • FG-.BG (faint foreground + background)
  • optional underline prefix: _{TOKEN}

Escaping:

• Non-token fragments unwrap as plain text, e.g. $hello$ -> hello, and $$ -> $.
• Inline token grammar is parsed only from input strings (e.g. c("$R:error$")); fluent builders like c.g do not accept $TOKEN:text$ as property syntax.

See Also

Github repository

• https://github.com/Chitaoji/colorfulstring/

PyPI project

• https://pypi.org/project/colorfulstring/

License

This project falls under the BSD 3-Clause License.

History

v0.0.3

• Now correctly handles escaped dollar sequences like $$ in inline token parsing.
• Improved README structure and polished API usage descriptions.

v0.0.2

• Added inline token grammar support ($TOKEN:text$) to render ANSI styles directly from plain strings.
• Added .underline and .faint style modifiers, including combinations with foreground/background colors.
• Improved chaining/conditional flow documentation and examples (iftrue, ifnot, ifelse, <<, @).

v0.0.1

• Renamed ColorfulString to ColorfulStringBuilder to avoid conflicts.

v0.0.0

• Initial release.