wasabi: 轻量级控制台打印和格式化工具包

多年来，我为我们的库（如spaCy、Thinc和Prodigy）编写了无数种着色和格式化工具的实现，用于输出消息。尽管有许多其他优秀的开源选项，但我始终希望有稍微不同或稍微定制的东西。

此包仍在开发中，旨在以标准化的方式捆绑这些工具，以便可以在我们的其他项目中共享。它非常轻量，没有依赖项，并且与Python 3.6+兼容。

💬 常见问题解答

您会添加更多功能吗？

是的，还有一些辅助功能和特性需要移植。然而，新功能将主要取决于我们（认为）需要的东西。我非常欢迎对现有功能的改进的pull请求——但我希望保持这个库尽可能简单、轻量级和具体。

我可以将其用于我的项目吗？

当然，如果你喜欢，请随意使用它！但请记住，这个包非常特定，并不旨在成为一个功能齐全且可完全自定义的格式化库。如果你在寻找这样的库，你可能需要尝试其他包——例如，colored、crayons、colorful、tabulate、console或py-term，仅举几个例子。

为什么叫wasabi？

我在寻找一个简短且描述性的名字，但所有的好名字都已经有人使用了。所以，我最终决定以我的其中一只仓鼠的名字Wasabi来命名这个包。🐀

⌛️ 安装

pip install wasabi

🎛 API

函数 msg

Printer的一个实例，使用默认配置初始化。如果不需要自定义初始化，这是一个有用的快速快捷方式。

from wasabi import msg

msg.good("Success!")

类 Printer

方法 Printer.__init__

from wasabi import Printer

msg = Printer()

方法 Printer.text

msg = Printer()
msg.text("Hello world!")

方法 Printer.good、Printer.fail、Printer.warn、Printer.info

打印特殊格式的消息。

msg = Printer()
msg.good("Success")
msg.fail("Error")
msg.warn("Warning")
msg.info("Info")

方法 Printer.divider

打印格式化的分隔符。

msg = Printer()
msg.divider("Heading")

上下文管理器 Printer.loading

msg = Printer()
with msg.loading("Loading..."):
    # Do something here that takes longer
    time.sleep(10)
msg.good("Successfully loaded something!")

方法 Printer.table、Printer.row

见表格。

属性 Printer.counts

获取特殊打印器被触发的次数，例如MESSAGES.GOOD。可用于打印概览，如"X个警告"。

msg = Printer()
msg.good("Success")
msg.fail("Error")
msg.warn("Error")

print(msg.counts)
# Counter({'good': 1, 'fail': 2, 'warn': 0, 'info': 0})

表格

函数 table

格式化表格数据的轻量级辅助函数。

from wasabi import table

data = [("a1", "a2", "a3"), ("b1", "b2", "b3")]
header = ("Column 1", "Column 2", "Column 3")
widths = (8, 9, 10)
aligns = ("r", "c", "l")
formatted = table(data, header=header, divider=True, widths=widths, aligns=aligns)

Column 1   Column 2    Column 3
--------   ---------   ----------
      a1      a2       a3
      b1      b2       b3

function row

from wasabi import row

data = ("a1", "a2", "a3")
formatted = row(data)

a1   a2   a3

class TracebackPrinter

输出自定义格式化的回溯和错误消息的辅助工具。目前在 Thinc 中使用。

method TracebackPrinter.__init__

初始化回溯打印器。

from wasabi import TracebackPrinter

tb = TracebackPrinter(tb_base="thinc", tb_exclude=("check.py",))

method TracebackPrinter.__call__

输出自定义格式化的回溯和错误。

from wasabi import TracebackPrinter
import traceback

tb = TracebackPrinter(tb_base="thinc", tb_exclude=("check.py",))

error = tb("Some error", "Error description", highlight="kwargs", tb=traceback.extract_stack())
raise ValueError(error)

  Some error
  Some error description

  Traceback:
  ├─ <lambda> [61] in .env/lib/python3.6/site-packages/pluggy/manager.py
  ├─── _multicall [187] in .env/lib/python3.6/site-packages/pluggy/callers.py
  └───── pytest_fixture_setup [969] in .env/lib/python3.6/site-packages/_pytest/fixtures.py
         >>> result = call_fixture_func(fixturefunc, request, kwargs)

class MarkdownRenderer

创建 Markdown 格式化内容的辅助工具。将按顺序存储添加到 Markdown 文档中的块。

from wasabi import MarkdownRenderer

md = MarkdownRenderer()
md.add(md.title(1, "Hello world"))
md.add("This is a paragraph")
print(md.text)

method MarkdownRenderer.__init__

初始化 Markdown 渲染器。

from wasabi import MarkdownRenderer

md = MarkdownRenderer()

method MarkdownRenderer.add

将块添加到 Markdown 文档中。

from wasabi import MarkdownRenderer

md = MarkdownRenderer()
md.add("This is a paragraph")

property MarkdownRenderer.text

渲染的 Markdown 文档。

md = MarkdownRenderer()
md.add("This is a paragraph")
print(md.text)

method MarkdownRenderer.table

创建 Markdown 格式化的表格。

md = MarkdownRenderer()
table = md.table([("a", "b"), ("c", "d")], ["Column 1", "Column 2"])
md.add(table)

| Column 1 | Column 2 |
| --- | --- |
| a | b |
| c | d |

方法 MarkdownRenderer.title

创建Markdown格式的标题。

md = MarkdownRenderer()
md.add(md.title(1, "Hello world"))
md.add(md.title(2, "Subheading", "💖"))

# Hello world

## 💖 Subheading

方法 MarkdownRenderer.list

创建Markdown格式的非嵌套列表。

md = MarkdownRenderer()
md.add(md.list(["item", "other item"]))
md.add(md.list(["first item", "second item"], numbered=True))

- item
- other item

1. first item
2. second item

方法 MarkdownRenderer.link

创建Markdown格式的链接。

md = MarkdownRenderer()
md.add(md.link("Google", "https://google.com"))

[Google](https://google.com)

方法 MarkdownRenderer.code_block

创建Markdown格式的代码块。

md = MarkdownRenderer()
md.add(md.code_block("import spacy", "python"))

```python
import spacy
```

方法 MarkdownRenderer.code，MarkdownRenderer.bold，MarkdownRenderer.italic

创建Markdown格式的文本。

md = MarkdownRenderer()
md.add(md.code("import spacy"))
md.add(md.bold("Hello!"))
md.add(md.italic("Emphasis"))

`import spacy`

**Hello!**

_Emphasis_

工具

函数 color

from wasabi import color

formatted = color("This is a text", fg="white", bg="green", bold=True)

函数 wrap

from wasabi import wrap

wrapped = wrap("Hello world, this is a text.", indent=2)

函数 diff_strings

from wasabi import diff_strings

diff = diff_strings("hello world!", "helloo world")

环境变量

Wasabi 还尊重以下环境变量。可以在 Printer 中通过 env_prefix 参数自定义前缀。例如，将 env_prefix="SPACY" 设置为将期望环境变量 SPACY_LOG_FRIENDLY。

🔔 运行测试

分叉或克隆存储库，确保您已安装 pytest 并在包目录上运行它。测试位于 /wasabi/tests。

pip install pytest
cd wasabi
python -m pytest wasabi