专属 Python 开发的完美终端工具

时间:2022-10-07 20:55:20

Rich 是一个非常强大的 Python 库,不仅在终端中提供丰富的文本和漂亮的格式,还可以显示表情符号、表格、进度条、标记,甚至语法突出显示的代码。

Rich 是一个 Python 库,可以为您在终端中提供富文本和精美格式。Rich API 可以很容易的在终端输出添加各种颜色和不同风格。Rich 还可以绘制漂亮的表格,进度条,markdown,突出显示语法的源代码及回溯等等,不胜枚举。

专属 Python 开发的完美终端工具

使用Rich来美化终端格式

1、兼容性

Rich 适用于 Linux,OSX 和 Windows。真彩色/表情符号可与新的 Windows 终端一起使用,Windows 的经典终端仅限 8 种颜色。Rich 还可以与Jupyter Notebook一起使用,而无需其他配置。

专属 Python 开发的完美终端工具

使用Rich来美化终端格式 - 功能纵览

2、安装说明

使用 pip 或其他 PyPi 软件包管理器进行安装。

bash

  1. pip install rich 

3、打印功能

想毫不费力地将 Rich 的输出功能添加到您的应用程序中,您只需导入rich 打印方法,该方法和其他 Python 的自带功能的参数类似。

python

  1. from rich import print  
  2. print("Hello, [bold magenta]World[/bold magenta]!", ":vampire:", locals()) 

专属 Python 开发的完美终端工具

使用Rich来美化终端格式 - 打印功能

4、使用控制台

想要对 Rich 终端内容进行更多控制,请您导入并构造一个控制台对象。

python

  1. from rich.console import Console  
  2. console = Console() 

Console 对象含有一个 print 方法,它的界面与 python 内置的 print 功能界面相似。

python

  1. console.print("Hello", "World!") 

您可能已经料到,这时终端上会显示 “Hello World”。请注意,与内置的 “打印” 功能不同,Rich 会将文字自动换行以适合终端宽度。

有几种方法可以为输出添加颜色和样式。您可以通过添加 style 关键字参数来为整个输出设置样式。

python

  1. console.print("Hello", "World!", style="bold red"

专属 Python 开发的完美终端工具

使用Rich来美化终端格式 - 使用控制台

这个范例一次只设置了一行文字的样式。如果想获得更细腻更复杂的样式,Rich 可以渲染一个特殊的标记,其语法类似于 bbcode。

python

  1. console.print("Where there is a [bold cyan]Will[/bold cyan] there [u]is[/u] a [i]way[/i].") 

专属 Python 开发的完美终端工具

使用Rich来美化终端格式 - 使用控制台

4.1 控制台记录

Console 对象具有一个 log() 方法,该方法具有与 print() 类似的界面,除此之外,还能成列显示当前时间以及被调用的文件和行。默认情况下,Rich 将针对 Python 结构和 repr 字符串进行语法突出显示。如果您记录一个集合(如字典或列表),Rich 会把它漂亮地打印出来,使其切合可用空间。

python

  1. from rich.console import Console  
  2. console = Console()  
  3. test_data = [  
  4.     {"jsonrpc": "2.0", "method": "sum", "params": [None, 1, 2, 4, False, True], "id": "1",},  
  5.     {"jsonrpc": "2.0", "method": "notify_hello", "params": [7]},  
  6.     {"jsonrpc": "2.0", "method": "subtract", "params": [42, 23], "id": "2"},  
  7.  
  8. def test_log():  
  9.     enabled = False  
  10.     context = {  
  11.         "foo": "bar",  
  12.     }  
  13.     movies = ["Deadpool", "Rise of the Skywalker"]  
  14.     console.log("Hello from", console, "!")  
  15.     console.log(test_data, log_locals=True 
  16. test_log() 

专属 Python 开发的完美终端工具

使用Rich来美化终端格式 - 日志

注意其中的 log_locals 参数会输出一个表格,该表格包含调用 log 方法的局部变量。log 方法既可用于将长时间运行应用程序(例如服务器)的日志记录到终端,也可用于辅助调试。

4.2 记录处理程序

您还可以使用内置的 处理类 来对 Python 日志记录模块的输出进行格式化和着色。

专属 Python 开发的完美终端工具

使用Rich来美化终端格式 - 记录

5、表情符号

将名称放在两个冒号之间即可在控制台输出中插入表情符号。

python

  1. >>> console.print(":smiley: :vampire: :pile_of_poo: :thumbs_up: :raccoon:")