mirror of https://github.com/Textualize/rich.git
439 lines
17 KiB
Markdown
439 lines
17 KiB
Markdown
[](https://pepy.tech/project/rich)
|
||
[](https://badge.fury.io/py/rich)
|
||
[](https://codecov.io/gh/Textualize/rich)
|
||
[](https://www.willmcgugan.com/tag/rich/)
|
||
[](https://twitter.com/willmcgugan)
|
||
|
||
|
||
|
||
[English readme](https://github.com/textualize/rich/blob/master/README.md)
|
||
• [简体中文 readme](https://github.com/textualize/rich/blob/master/README.cn.md)
|
||
• [正體中文 readme](https://github.com/textualize/rich/blob/master/README.zh-tw.md)
|
||
• [Lengua española readme](https://github.com/textualize/rich/blob/master/README.es.md)
|
||
• [Deutsche readme](https://github.com/textualize/rich/blob/master/README.de.md)
|
||
• [Läs på svenska](https://github.com/textualize/rich/blob/master/README.sv.md)
|
||
• [日本語 readme](https://github.com/textualize/rich/blob/master/README.ja.md)
|
||
• [한국어 readme](https://github.com/textualize/rich/blob/master/README.kr.md)
|
||
• [Français readme](https://github.com/textualize/rich/blob/master/README.fr.md)
|
||
• [Schwizerdütsch readme](https://github.com/textualize/rich/blob/master/README.de-ch.md)
|
||
• [हिन्दी readme](https://github.com/textualize/rich/blob/master/README.hi.md)
|
||
• [Português brasileiro readme](https://github.com/textualize/rich/blob/master/README.pt-br.md)
|
||
• [Italian readme](https://github.com/textualize/rich/blob/master/README.it.md)
|
||
• [Русский readme](https://github.com/textualize/rich/blob/master/README.ru.md)
|
||
• [فارسی readme](https://github.com/textualize/rich/blob/master/README.fa.md)
|
||
• [Türkçe readme](https://github.com/textualize/rich/blob/master/README.tr.md)
|
||
• [Polskie readme](https://github.com/textualize/rich/blob/master/README.pl.md)
|
||
|
||
Rich 是一个 Python 库，可以为您在终端中提供富文本和精美格式。
|
||
|
||
[Rich 的 API](https://rich.readthedocs.io/en/latest/) 让在终端输出颜色和样式变得很简单。此外，Rich 还可以绘制漂亮的表格、进度条、markdown、语法高亮的源代码以及栈回溯信息（tracebacks）等——开箱即用。
|
||
|
||
|
||
|
||
有关 Rich 的视频介绍，请参见
|
||
[@fishnets88](https://twitter.com/fishnets88) 录制的
|
||
[calmcode.io](https://calmcode.io/rich/introduction.html)。
|
||
|
||
## 兼容性
|
||
|
||
Rich 适用于 Linux，OSX 和 Windows。真彩色/表情符号可与新的 Windows 终端一起使用，Windows 的经典终端仅限 8 种颜色。
|
||
|
||
Rich 还可以与 [Jupyter 笔记本](https://jupyter.org/)一起使用，而无需其他配置。
|
||
|
||
## 安装说明
|
||
|
||
使用`pip`或其他 PyPI 软件包管理器进行安装。
|
||
|
||
```sh
|
||
python -m pip install rich
|
||
```
|
||
|
||
## Rich 的打印功能
|
||
|
||
想毫不费力地将 Rich 的输出功能添加到您的应用程序中，您只需导入 [rich print](https://rich.readthedocs.io/en/latest/introduction.html#quick-start) 方法，它和 Python 内置的同名函数有着完全一致的函数签名。试试看：
|
||
|
||
```python
|
||
from rich import print
|
||
|
||
print("Hello, [bold magenta]World[/bold magenta]!", ":vampire:", locals())
|
||
```
|
||
|
||
|
||
|
||
## 在交互式命令行（REPL）中使用 Rich
|
||
|
||
Rich 可以被安装到 Python 交互式命令行中，那样做以后，任何数据结构都可以被漂亮的打印出来，自带语法高亮。
|
||
|
||
```python
|
||
>>> from rich import pretty
|
||
>>> pretty.install()
|
||
```
|
||
|
||
|
||
|
||
## 使用控制台
|
||
|
||
想要对 Rich 终端内容进行更多控制，请您导入并构造一个[控制台](https://rich.readthedocs.io/en/latest/reference/console.html#rich.console.Console)对象。
|
||
|
||
```python
|
||
from rich.console import Console
|
||
|
||
console = Console()
|
||
```
|
||
|
||
Console 对象包含一个`print`方法，它和语言内置的`print`函数有着相似的接口。下面是一段使用样例：
|
||
|
||
```python
|
||
console.print("Hello", "World!")
|
||
```
|
||
|
||
您可能已经料到，这时终端上会显示“ Hello World！”。请注意，与内置的“print”函数不同，Rich 会将文字自动换行以适合终端宽度。
|
||
|
||
有好几种方法可以为输出添加颜色和样式。您可以通过添加`style`关键字参数来为整个输出设置样式。例子如下：
|
||
|
||
```python
|
||
console.print("Hello", "World!", style="bold red")
|
||
```
|
||
|
||
输出如下图：
|
||
|
||
|
||
|
||
这个范例一次只设置了一行文字的样式。如果想获得更细腻更复杂的样式，Rich 可以渲染一个特殊的标记，其语法类似于[bbcode](https://en.wikipedia.org/wiki/BBCode)。示例如下：
|
||
|
||
```python
|
||
console.print("Where there is a [bold cyan]Will[/bold cyan] there [u]is[/u] a [i]way[/i].")
|
||
```
|
||
|
||
|
||
|
||
使用`Console`对象，你可以花最少的工夫生成复杂的输出。更详细的内容可查阅 [Console API](https://rich.readthedocs.io/en/latest/console.html) 文档。
|
||
|
||
## Rich Inspect
|
||
|
||
Rich 提供一个 [inspect](https://rich.readthedocs.io/en/latest/reference/init.html?highlight=inspect#rich.inspect) 函数来给任意的 Python 对象打印报告，比如类（class）、实例（instance）和内置对象（builtin）等。
|
||
|
||
```python
|
||
>>> my_list = ["foo", "bar"]
|
||
>>> from rich import inspect
|
||
>>> inspect(my_list, methods=True)
|
||
```
|
||
|
||
|
||
|
||
查看 [inspect 文档](https://rich.readthedocs.io/en/latest/reference/init.html#rich.inspect)详细了解。
|
||
|
||
# Rich 库内容
|
||
|
||
Rich 包含了一系列内置的 _可渲染类型(renderables)_ ，你可以用它们为命令行程序构建出优雅的输出，也可以拿它们来辅助调试你的代码。
|
||
|
||
点击以下标题查看详细：
|
||
|
||
<details>
|
||
<summary>日志（Log）</summary>
|
||
|
||
Console 对象有一个与`print()`类似的`log()`方法，但它会多输出一列内容，里面包含当前时间以及调用方法的文件行号。默认情况下，Rich 将针对 Python 结构和 repr 字符串添加语法高亮。如果您记录一个集合（如字典或列表），Rich 会把它漂亮地打印出来，使其切合可用空间。下面是其中一些功能的示例：
|
||
|
||
```python
|
||
from rich.console import Console
|
||
console = Console()
|
||
|
||
test_data = [
|
||
{"jsonrpc": "2.0", "method": "sum", "params": [None, 1, 2, 4, False, True], "id": "1",},
|
||
{"jsonrpc": "2.0", "method": "notify_hello", "params": [7]},
|
||
{"jsonrpc": "2.0", "method": "subtract", "params": [42, 23], "id": "2"},
|
||
]
|
||
|
||
def test_log():
|
||
enabled = False
|
||
context = {
|
||
"foo": "bar",
|
||
}
|
||
movies = ["Deadpool", "Rise of the Skywalker"]
|
||
console.log("Hello from", console, "!")
|
||
console.log(test_data, log_locals=True)
|
||
|
||
|
||
test_log()
|
||
```
|
||
|
||
以上范例的输出如下：
|
||
|
||
|
||
|
||
注意其中的`log_locals`参数会输出一个表格，该表格包含调用 log 方法的局部变量。
|
||
|
||
log 方法既可用于将常驻进程（例如服务器进程）的日志打印到终端，在调试时也是个好帮手。
|
||
|
||
</details>
|
||
<details>
|
||
<summary>日志处理器（Logging Handler）</summary>
|
||
|
||
您还可以使用内置的[处理器类](https://rich.readthedocs.io/en/latest/logging.html)来对 Python 的 logging 模块的输出进行格式化和着色。下面是输出示例：
|
||
|
||
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Emoji 表情</summary>
|
||
|
||
将名称放在两个冒号之间即可在控制台输出中插入 emoji 表情符。示例如下：
|
||
|
||
```python
|
||
>>> console.print(":smiley: :vampire: :pile_of_poo: :thumbs_up: :raccoon:")
|
||
😃 🧛 💩 👍 🦝
|
||
```
|
||
|
||
请谨慎地使用此功能。
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>表格（Tables）</summary>
|
||
|
||
Rich 可以使用 Unicode 框字符来呈现多变的[表格](https://rich.readthedocs.io/en/latest/tables.html)。Rich 包含多种边框，样式，单元格对齐等格式设置的选项。下面是一个简单的示例：
|
||
|
||
```python
|
||
from rich.console import Console
|
||
from rich.table import Column, Table
|
||
|
||
console = Console()
|
||
|
||
table = Table(show_header=True, header_style="bold magenta")
|
||
table.add_column("Date", style="dim", width=12)
|
||
table.add_column("Title")
|
||
table.add_column("Production Budget", justify="right")
|
||
table.add_column("Box Office", justify="right")
|
||
table.add_row(
|
||
"Dec 20, 2019", "Star Wars: The Rise of Skywalker", "$275,000,000", "$375,126,118"
|
||
)
|
||
table.add_row(
|
||
"May 25, 2018",
|
||
"[red]Solo[/red]: A Star Wars Story",
|
||
"$275,000,000",
|
||
"$393,151,347",
|
||
)
|
||
table.add_row(
|
||
"Dec 15, 2017",
|
||
"Star Wars Ep. VIII: The Last Jedi",
|
||
"$262,000,000",
|
||
"[bold]$1,332,539,889[/bold]",
|
||
)
|
||
|
||
console.print(table)
|
||
```
|
||
|
||
该示例的输出如下：
|
||
|
||
|
||
|
||
请注意，控制台标记的呈现方式与`print()`和`log()`相同。实际上，由 Rich 渲染的任何内容都可以添加到标题/行（甚至其他表格）中。
|
||
|
||
`Table`类很聪明，可以调整列的大小以适合终端的可用宽度，并能根据需要对文字折行。下面是相同的示例，输出与比上表小的终端上：
|
||
|
||
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>进度条（Progress Bars）</summary>
|
||
|
||
Rich 可以渲染多种“无闪烁”的[进度](https://rich.readthedocs.io/en/latest/progress.html)条图形，以跟踪长时间运行的任务。
|
||
|
||
基本用法：用`track`函数调用任何程序并迭代结果。下面是一个例子：
|
||
|
||
```python
|
||
from rich.progress import track
|
||
|
||
for step in track(range(100)):
|
||
do_step(step)
|
||
```
|
||
|
||
添加多个进度条并不难。以下是从文档中获取的示例：
|
||
|
||
|
||
|
||
这些列可以配置为显示您所需的任何详细信息。内置列包括完成百分比，文件大小，文件速度和剩余时间。下面是显示正在进行的下载的示例：
|
||
|
||
|
||
|
||
要自己尝试一下，请参阅[examples/downloader.py](https://github.com/textualize/rich/blob/master/examples/downloader.py)，它可以在显示进度的同时下载多个 URL。
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>状态动画（Status）</summary>
|
||
|
||
对于那些很难计算进度的情况，你可以使用 [status](https://rich.readthedocs.io/en/latest/reference/console.html#rich.console.Console.status) 方法，它会展示一个“环形旋转（spinner）”的动画和文字信息。这个动画并不会妨碍你正常使用控制台。下面是个例子：
|
||
|
||
```python
|
||
from time import sleep
|
||
from rich.console import Console
|
||
|
||
console = Console()
|
||
tasks = [f"task {n}" for n in range(1, 11)]
|
||
|
||
with console.status("[bold green]Working on tasks...") as status:
|
||
while tasks:
|
||
task = tasks.pop(0)
|
||
sleep(1)
|
||
console.log(f"{task} complete")
|
||
```
|
||
|
||
这会往终端生成以下输出：
|
||
|
||
|
||
|
||
这个旋转动画借鉴自 [cli-spinners](https://www.npmjs.com/package/cli-spinners) 项目。你可以通过`spinner`参数指定一种动画效果。执行以下命令来查看所有可选值：
|
||
|
||
```
|
||
python -m rich.spinner
|
||
```
|
||
|
||
这会往终端输出以下内容：
|
||
|
||
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>树（Tree）</summary>
|
||
|
||
Rich 可以渲染一个包含引导线的[树（tree）](https://rich.readthedocs.io/en/latest/tree.html)。对于展示文件目录结构和其他分级数据来说，树是理想选择。
|
||
|
||
树的标签可以是简单文本或任何 Rich 能渲染的东西。执行以下命令查看演示：
|
||
|
||
```
|
||
python -m rich.tree
|
||
```
|
||
|
||
这会产生以下输出：
|
||
|
||
|
||
|
||
[tree.py](https://github.com/textualize/rich/blob/master/examples/tree.py) 是一个展示任意目录的文件树视图的样例文件，类似于 Linux 中的 `tree` 命令。
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>列（Columns）</summary>
|
||
|
||
Rich 可以将内容通过排列整齐的，具有相等或最佳的宽度的[列](https://rich.readthedocs.io/en/latest/columns.html)来呈现。下面是（macOS / Linux）`ls`命令的一个非常基本的克隆，用于用列来显示目录列表：
|
||
|
||
```python
|
||
import os
|
||
import sys
|
||
|
||
from rich import print
|
||
from rich.columns import Columns
|
||
|
||
directory = os.listdir(sys.argv[1])
|
||
print(Columns(directory))
|
||
```
|
||
|
||
以下屏幕截图是[列示例](https://github.com/textualize/rich/blob/master/examples/columns.py)的输出，该列显示了从 API 提取的数据：
|
||
|
||
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Markdown</summary>
|
||
|
||
Rich 可以呈现[markdown](https://rich.readthedocs.io/en/latest/markdown.html)，并可相当不错的将其格式转移到终端。
|
||
|
||
为了渲染 markdown，请导入`Markdown`类，并使用包含 markdown 代码的字符串来构造它，然后将其打印到控制台。例子如下：
|
||
|
||
```python
|
||
from rich.console import Console
|
||
from rich.markdown import Markdown
|
||
|
||
console = Console()
|
||
with open("README.md") as readme:
|
||
markdown = Markdown(readme.read())
|
||
console.print(markdown)
|
||
```
|
||
|
||
该例子的输出如下图：
|
||
|
||
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>语法高亮（Syntax Highlighting）</summary>
|
||
|
||
Rich 使用[pygments](https://pygments.org/)库来实现[语法高亮显示](https://rich.readthedocs.io/en/latest/syntax.html)。用法类似于渲染 markdown。构造一个`Syntax`对象并将其打印到控制台。下面是一个例子：
|
||
|
||
```python
|
||
from rich.console import Console
|
||
from rich.syntax import Syntax
|
||
|
||
my_code = '''
|
||
def iter_first_last(values: Iterable[T]) -> Iterable[Tuple[bool, bool, T]]:
|
||
"""Iterate and generate a tuple with a flag for first and last value."""
|
||
iter_values = iter(values)
|
||
try:
|
||
previous_value = next(iter_values)
|
||
except StopIteration:
|
||
return
|
||
first = True
|
||
for value in iter_values:
|
||
yield first, False, previous_value
|
||
first = False
|
||
previous_value = value
|
||
yield first, True, previous_value
|
||
'''
|
||
syntax = Syntax(my_code, "python", theme="monokai", line_numbers=True)
|
||
console = Console()
|
||
console.print(syntax)
|
||
```
|
||
|
||
输出如下：
|
||
|
||
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>栈回溯信息（Tracebacks）</summary>
|
||
|
||
Rich 可以渲染出漂亮的[栈回溯信息](https://rich.readthedocs.io/en/latest/traceback.html)，它比标准的 Python 格式更容易阅读，且能显示更多的代码。您可以将 Rich 设置为默认的栈回溯处理程序，这样所有未捕获的异常都将由 Rich 为渲染。
|
||
|
||
下面是在 OSX（在 Linux 上也类似）系统的效果：
|
||
|
||
|
||
|
||
</details>
|
||
|
||
所有的 Rich 可渲染对象都采用了 [Console Protocol](https://rich.readthedocs.io/en/latest/protocol.html) 协议，你可以用该协议实现你独有的 Rich 内容。
|
||
|
||
## 使用 Rich 的项目
|
||
|
||
这里是一些使用 Rich 的项目:
|
||
|
||
- [BrancoLab/BrainRender](https://github.com/BrancoLab/BrainRender)
|
||
一个用于三维神经解剖数据可视化的 python 包
|
||
- [Ciphey/Ciphey](https://github.com/Ciphey/Ciphey)
|
||
自动解密工具
|
||
- [emeryberger/scalene](https://github.com/emeryberger/scalene)
|
||
一个高性能、高精度的 Python CPU 和内存剖析器
|
||
- [hedythedev/StarCli](https://github.com/hedythedev/starcli)
|
||
通过命令行浏览 GitHub 热门项目
|
||
- [intel/cve-bin-tool](https://github.com/intel/cve-bin-tool)
|
||
这个工具可以扫描一些常见的、有漏洞的组件（openssl、libpng、libxml2、expat和其他一些组件），让你知道你的系统是否包含有已知漏洞的常用库。
|
||
- [nf-core/tools](https://github.com/nf)
|
||
包含 nf-core 社区帮助工具的 Python 包
|
||
- [cansarigol/pdbr](https://github.com/cansarigol/pdbr)
|
||
pdb + rich 的库，增强调试功能
|
||
- [plant99/felicette](https://github.com/plant99/felicette)
|
||
傻瓜式卫星图像
|
||
- [seleniumbase/SeleniumBase](https://github.com/seleniumbase/SeleniumBase)
|
||
使用 Selenium 和 pytest 使自动化和测试速度提高10倍，包括电池
|
||
- [smacke/ffsubsync](https://github.com/smacke/ffsubsync)
|
||
自动将字幕与视频同步
|
||
- [tryolabs/norfair](https://github.com/tryolabs/norfair)
|
||
轻量级 Python 库，用于向任何检测器添加实时 2D 对象跟踪
|
||
- +[还有很多](https://github.com/textualize/rich/network/dependents)!
|