Rich 是一个 Python 库,可以在终端中提供富文本和漂亮、精美的格式。 使用 Rich API 可以很容易的在终端输出添加各种颜色和不同风格。 它可以绘制漂亮的表格,进度条,markdown,突出显示语法的源代码及回溯等等, 优秀的功能不胜枚举。
Rich 适用于 Linux,OSX 和 Windows。可与新的 Windows 终端一起使用, Windows 的经典终端仅限 8 种颜色。 Rich 还可以与 Jupyter NoteBook 一起使用,而无需其他配置。
安装说明
请选择以下任一种方式输入命令安装依赖:
Windows 环境 打开 Cmd
(开始-运行-CMD)。
MacOS 环境 打开 Terminal (command+空格输入Terminal)。
如果用的是 VSCode编辑器 或 Pycharm,
可以直接使用界面下方的Terminal。
pip install rich
from rich import print
print("Hello, [bold magenta]World[/bold magenta]!", ":vampire:", locals())
Hello, World! 🧛 { '__name__': '__main__', '__doc__': 'Automatically created module for IPython interactive environment', '__package__': None, '__loader__': None, '__spec__': None, '__builtin__': <module 'builtins' (built-in)>, '__builtins__': <module 'builtins' (built-in)>, '_ih': [ '', 'from rich import print\nprint("Hello, [bold magenta]World[/bold magenta]!", ":vampire:", locals())' ], '_oh': {}, '_dh': [PosixPath('/home/jovyan/work/jupylab_houxue/pt05_tool/ch09_misc')], 'In': [ '', 'from rich import print\nprint("Hello, [bold magenta]World[/bold magenta]!", ":vampire:", locals())' ], 'Out': {}, 'get_ipython': <bound method InteractiveShell.get_ipython of <ipykernel.zmqshell.ZMQInteractiveShell object at 0x7ff6cc1f1700>>, 'exit': <IPython.core.autocall.ZMQExitAutocall object at 0x7ff6cc25a8d0>, 'quit': <IPython.core.autocall.ZMQExitAutocall object at 0x7ff6cc25a8d0>, 'open': <function open at 0x7ff6d0214900>, '_': '', '__': '', '___': '', '__session__': '/home/jovyan/work/jupylab_houxue/pt05_tool/ch09_misc/sec03_Rich---Python开发者的终端工具!_jt95bf.ipynb', '_i': '', '_ii': '', '_iii': '', '_i1': 'from rich import print\nprint("Hello, [bold magenta]World[/bold magenta]!", ":vampire:", locals())', 'print': <function print at 0x7ff6bde068e0> }
from rich.console import Console
console = Console()
Console
对象含有一个 print
方法,
它的界面与 Python 内置的 print
功能相似,可以试试:
console.print("Hello", "World!")
Hello World!
可能已经料到,这时终端上会显示“ Hello World!”,
请注意,与内置的“打印”功能不同,Rich
会将文字自动换行以适合终端宽度。
有几种方法可以为输出添加自定义颜色和样式。
可以通过添加 style
关键字参数来为整个输出设置样式。例子如下:
console.print("Hello", "World!", style="bold red")
Hello World!
这个范例一次只设置了一行文字的样式。如果想获得更细腻更复杂的样式,
Rich
可以渲染一个特殊的标记,其语法类似于 bbcode。示例如下:
console.print("Where there is a [bold cyan]Will[/bold cyan] there [u]is[/u] a [i]way[/i].")
Where there is a Will there is a way.
Console
对象具有一个 log()
方法,
该方法具有与 print()
类似的界面,除此之外,
还能显示当前时间以及被调用的文件和行。
默认情况下,Rich
将针对 Python 结构和 repr
字符串进行语法突出显示。
如果记录一个集合(如字典或列表),Rich
会把它漂亮地打印出来,
使其切合可用空间。下面是其中一些功能的示例:
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()
[08:16:51] Hello from <console width=115 ColorSystem.TRUECOLOR> ! 3191036825.py:7
[ 3191036825.py:8 { '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'} ] ╭──────────────────── locals ─────────────────────╮ │ context = {'foo': 'bar'} │ │ enabled = False │ │ movies = ['Deadpool', 'Rise of the Skywalker'] │ ╰─────────────────────────────────────────────────╯
console.print(":smiley: :vampire: :pile_of_poo: :thumbs_up: :raccoon:")
😃 🧛 💩 👍 🦝
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(
"Dev 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)
┏━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┓ ┃ Date ┃ Title ┃ Production Budget ┃ Box Office ┃ ┡━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━┩ │ Dev 20, 2019 │ Star Wars: The Rise of Skywalker │ $275,000,000 │ $375,126,118 │ │ May 25, 2018 │ Solo: A Star Wars Story │ $275,000,000 │ $393,151,347 │ │ Dec 15, 2017 │ Star Wars Ep. VIII: The Last Jedi │ $262,000,000 │ $1,332,539,889 │ └──────────────┴───────────────────────────────────┴───────────────────┴────────────────┘
# from rich.progress import track
# def do_step(idx):
# out = idx * 50
# for step in track(range(100)):
# do_step(step)
Output()
import os
import sys
from rich import print
from rich.columns import Columns
directory = os.listdir('../..')
print(Columns(directory))
README.md push_code.sh .git pt01_basic pt04_essential pt05_tool Python简化日常工作流程! Python解决日常问题和错误 sec01_tmpl.ipynb .gitignore .ipynb_checkpoints clean_err.py pt07_dip
from rich.console import Console
from rich.markdown import Markdown
console = Console()
# with open("../../README.md") as readme:
markdown = Markdown(
'''
- list1
- list2
- list3
```python3
print('Hello')
```
'''
)
console.print(markdown)
• list1 • list2 • list3 print('Hello')
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)
1 2 def iter_first_last(values: Iterable[T]) -> Iterable[Tuple[bool, bool, T]]: 3 """Iterate and generate a tuple with a flag for first and last value.""" 4 iter_values = iter(values) 5 try: 6 previous_value = next(iter_values) 7 except StopIteration: 8 return 9 first = True 10 for value in iter_values: 11 yield first, False, previous_value 12 first = False 13 previous_value = value 14 yield first, True, previous_value 15