Wasabi

1.1.3 · active · verified Sun Mar 29

Wasabi is a lightweight console printing and formatting toolkit designed by Explosion, the creators of spaCy. It aims to make console output more readable and visually appealing with minimal overhead. The library is currently at version 1.1.3 and is actively maintained, receiving regular updates often in conjunction with other Explosion projects.

Warnings

breaking Wasabi dropped support for Python 3.5 and earlier versions starting from v1.1.0. Ensure your environment uses Python 3.6 or newer.
Fix: Upgrade your Python interpreter to version 3.6 or higher.
gotcha The `Printer.fail()` method, when called with `exits=True` or `exits=1`, will terminate the script by calling `sys.exit()` after printing. This is useful for critical failures but can halt execution prematurely if not intended.
Fix: Avoid `exits=True` in non-critical scenarios or wrap the call in a `try-except SystemExit` block if you need to catch the exit.
gotcha The `from wasabi import msg` object is a pre-configured `Printer` instance. If you need custom settings (e.g., `pretty=False`, different colors), you must instantiate `from wasabi import Printer` directly.
Fix: Use `msg = Printer(pretty=False, ...)` for customized behavior instead of the global `msg` object.
gotcha Wasabi is designed to be lightweight and specific for console output by Explosion's projects. For highly complex or full-featured formatting needs, consider alternative, more general-purpose libraries.
Fix: Evaluate your formatting requirements; for advanced table rendering, progress bars, or highly custom UI elements, other libraries may be more suitable.

Install

pip install wasabi Install stable version

Imports

Printer
```
from wasabi import Printer
```
msg
```
from wasabi import msg
```
Pre-initialized Printer instance for quick use without custom configuration.

Quickstart

Initializes a `Printer` instance to format and print messages with various styles (good, warn, fail, info, text) and includes dividers. It also demonstrates using the pre-initialized `msg` object.

from wasabi import Printer

# Instantiate a Printer for custom configuration
msg = Printer(pretty=True, hide_tags=False)

msg.text("Starting application...", icon="🚀")
msg.good("Configuration loaded successfully.")
msg.warn("API key not found, running in limited mode.")
msg.fail("Database connection failed.")

# Print a divider
msg.divider("Summary")

# Using the global 'msg' instance (pre-configured)
from wasabi import msg as default_msg
default_msg.info("Default printer message.")

view raw JSON →