AnsiMarkup

2.2.0 · active · verified Fri Apr 17

Ansimarkup is a Python library that simplifies producing colored and styled terminal text using an XML-like markup syntax. It translates tags like `<red>Hello</red>` into appropriate ANSI escape codes, supporting various colors, styles (bold, italic, underline), and background colors. The library is currently at version 2.2.0, with stable, albeit infrequent, releases.

Common errors

```
TypeError: 'AnsiMarkup' object is not callable
```
cause In `ansimarkup` versions 2.0.0 and above, `AnsiMarkup` instances are no longer directly callable like a function. This was a deprecated feature in 1.x and removed in 2.x.

fix Explicitly use the `parse` method: `am.parse("<red>Error</red>")` instead of `am("<red>Error</red>")`.
```
NameError: name 'strip_markup' is not defined
```
cause The `strip_markup` function was removed from the top-level `ansimarkup` module and `AnsiMarkup` class in version 2.0.0.

fix Import and use the new standalone `strip` function: `from ansimarkup import strip; plain_text = strip("<bold>Markup</bold>")`.
```
My terminal output shows raw ANSI escape codes or no colors at all.
```
cause The terminal you are using may not support ANSI escape codes, or the output is being redirected (e.g., to a file, pipe, or non-interactive environment) where `ansimarkup` might disable colors by default.

fix Ensure you are running in an ANSI-compatible terminal (e.g., most Linux/macOS terminals, modern Windows Terminal). If you need to force colors even when output is redirected, you can initialize `AnsiMarkup(force_colors=True)`. However, this might result in raw escape codes in truly incompatible environments or files.

Warnings

breaking Major API changes in AnsiMarkup 2.0.0 removed direct callability of `AnsiMarkup` instances and arguments like `stdout`/`stream` from the constructor and `parse` method.
Fix: Instead of `am('text')`, use `am.parse('text')`. For direct printing to a stream, use the `ansiprint` function. If you need a custom stream for parsing, pass it to the `AnsiMarkup` constructor: `AnsiMarkup(stream=my_stream)`.
breaking The `strip_markup` function/method was removed from the `AnsiMarkup` class and `ansimarkup` module namespace in version 2.0.0.
Fix: Replace calls to `AnsiMarkup().strip_markup(text)` or `ansimarkup.strip_markup(text)` with `from ansimarkup import strip; strip(text)`.
gotcha Tag case-sensitivity changed in AnsiMarkup 2.0.0. Tags are now case-sensitive by default.
Fix: Ensure consistent casing for your tags (e.g., always `<red>` not `<Red>`). If you require case-insensitive tags for backwards compatibility, initialize `AnsiMarkup(case_sensitive=False)`.

Install

pip install ansimarkup Install latest version

Imports

AnsiMarkup
```
from ansimarkup import AnsiMarkup
```
ansiprint
```
from ansimarkup import ansiprint
```
Useful for direct printing to a stream with markup.
strip
wrong:
```
from ansimarkup import strip_markup
```
correct:
```
from ansimarkup import strip
```
`strip_markup` was removed in 2.0.0, replaced by `ansimarkup.strip`.

Quickstart

Demonstrates initializing AnsiMarkup to parse text and using `ansiprint` for direct output, showcasing basic colored and styled text.

from ansimarkup import AnsiMarkup

# Create an AnsiMarkup instance
am = AnsiMarkup()

# Use the parse method to convert markup to ANSI colored text
text = am.parse("<red>Error:</red> <bold>Something went wrong!</bold>")
print(text)

# Or, use ansiprint for direct output
from ansimarkup import ansiprint
ansiprint("<green>Success:</green> Operation complete!")

view raw JSON →