9.3. Rich:Python开发者的终端工具!

Rich 是一个 Python 库,可以为你在终端中提供富文本和漂亮、精美的格式。

使用 Rich API 可以很容易的在终端输出添加各种颜色和不同风格。 它可以绘制漂亮的表格,进度条,markdown,突出显示语法的源代码及回溯等等,优秀的功能不胜枚举。

Rich 适用于 Linux,OSX 和 Windows。可与新的 Windows 终端一起使用,Windows 的经典终端仅限 8 种颜色。

Rich 还可以与 Jupyter NoteBook 一起使用,而无需其他配置。

9.3.1. Rich 安装说明

请选择以下任一种方式输入命令安装依赖:

Windows 环境 打开 Cmd (开始-运行-CMD)。 MacOS 环境 打开 Terminal (command+空格输入Terminal)。 如果你用的是 VSCode编辑器 或 Pycharm,可以直接使用界面下方的Terminal.

pip install rich

9.3.2. Rich 的 Print 功能

想毫不费力地将 Rich 的输出功能添加到你的Python脚本程序中,你只需导入 rich print 方法,该方法和其他 Python 的自带功能的参数类似。你可以试试:

>>> 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())',
        'from rich.console import Console\nconsole = Console()\nConsole 对象含有一个 print 方法,它的界面与 python 
内置的 print 功能相似。你可以试试:\n\nconsole.print("Hello", "World!")',
        'from rich.console import Console\nconsole = Console()',
        'console.print("Hello", "World!")',
        'console.print("Hello", "World!", style="bold red")',
        'console.print("Where there is a [bold cyan]Will[/bold cyan] there [u]is[/u] a [i]way[/i].")',
        'from rich.console import Console\nconsole = Console()\n\ntest_data = [\n    {"jsonrpc": "2.0", "method": 
"sum", "params": [None, 1, 2, 4, False, True], "id": "1",},\n    {"jsonrpc": "2.0", "method": "notify_hello", 
"params": [7]},\n    {"jsonrpc": "2.0", "method": "subtract", "params": [42, 23], "id": "2"},\n]\n\ndef 
test_log():\n    enabled = False\n    context = {\n        "foo": "bar",\n    }\n    movies = ["Deadpool", "Rise of
the Skywalker"]\n    console.log("Hello from", console, "!")\n    console.log(test_data, 
log_locals=True)\n\n\ntest_log()',
        'console.print(":smiley: :vampire: :pile_of_poo: :thumbs_up: :raccoon:")',
        'from rich.console import Console\nfrom rich.table import Column, Table\n\nconsole = Console()\n\ntable = 
Table(show_header=True, header_style="bold magenta")\ntable.add_column("Date", style="dim", 
width=12)\ntable.add_column("Title")\ntable.add_column("Production Budget", justify="right")\ntable.add_column("Box
Office", justify="right")\ntable.add_row(\n    "Dev 20, 2019", "Star Wars: The Rise of Skywalker", "$275,000,000", 
"$375,126,118"\n)\ntable.add_row(\n    "May 25, 2018",\n    "[red]Solo[/red]: A Star Wars Story",\n    
"$275,000,000",\n    "$393,151,347",\n)\ntable.add_row(\n    "Dec 15, 2017",\n    "Star Wars Ep. VIII: The Last 
Jedi",\n    "$262,000,000",\n    "[bold]$1,332,539,889[/bold]",\n)\n\nconsole.print(table)',
        'from rich.progress import track\n\nfor step in track(range(100)):\n    do_step(step)',
        'from rich.progress import track\ndef do_step(idx):\n    out = idx * 50\nfor step in track(range(100)):\n  
do_step(step)',
        'import os\nimport sys\n\nfrom rich import print\nfrom rich.columns import Columns\n\ndirectory = 
os.listdir(sys.argv[1])\nprint(Columns(directory))',
        "import os\nimport sys\n\nfrom rich import print\nfrom rich.columns import Columns\n\ndirectory = 
os.listdir('..)\nprint(Columns(directory))",
        "import os\nimport sys\n\nfrom rich import print\nfrom rich.columns import Columns\n\ndirectory = 
os.listdir('..')\nprint(Columns(directory))",
        "import os\nimport sys\n\nfrom rich import print\nfrom rich.columns import Columns\n\ndirectory = 
os.listdir('../..')\nprint(Columns(directory))",
        'from rich.console import Console\nfrom rich.markdown import Markdown\n\nconsole = Console()\nwith 
open("README.md") as readme:\n    markdown = Markdown(readme.read())\nconsole.print(markdown)',
        'from rich.console import Console\nfrom rich.syntax import Syntax\n\nmy_code = \'\'\'\ndef 
iter_first_last(values: Iterable[T]) -&gt; Iterable[Tuple[bool, bool, T]]:\n    """Iterate and generate a tuple 
with a flag for first and last value."""\n    iter_values = iter(values)\n    try:\n        previous_value = 
next(iter_values)\n    except StopIteration:\n        return\n    first = True\n    for value in iter_values:\n    
yield first, False, previous_value\n        first = False\n        previous_value = value\n    yield first, True, 
previous_value\n\'\'\'\nsyntax = Syntax(my_code, "python", theme="monokai", line_numbers=True)\nconsole = 
Console()\nconsole.print(syntax)',
        'from rich.console import Console\nfrom rich.markdown import Markdown\n\nconsole = Console()\nwith 
open("../../README.md") as readme:\n    markdown = Markdown(readme.read())\nconsole.print(markdown)',
        'from rich import print\nprint("Hello, [bold magenta]World[/bold magenta]!", ":vampire:", locals())'
    ],
    '_oh': {},
    '_dh': [PosixPath('/home/bk/book-jubook/python/jubook_python/pt05_tool/ch08_misc')],
    'In': [
        '',
        'from rich import print\nprint("Hello, [bold magenta]World[/bold magenta]!", ":vampire:", locals())',
        'from rich.console import Console\nconsole = Console()\nConsole 对象含有一个 print 方法,它的界面与 python 
内置的 print 功能相似。你可以试试:\n\nconsole.print("Hello", "World!")',
        'from rich.console import Console\nconsole = Console()',
        'console.print("Hello", "World!")',
        'console.print("Hello", "World!", style="bold red")',
        'console.print("Where there is a [bold cyan]Will[/bold cyan] there [u]is[/u] a [i]way[/i].")',
        'from rich.console import Console\nconsole = Console()\n\ntest_data = [\n    {"jsonrpc": "2.0", "method": 
"sum", "params": [None, 1, 2, 4, False, True], "id": "1",},\n    {"jsonrpc": "2.0", "method": "notify_hello", 
"params": [7]},\n    {"jsonrpc": "2.0", "method": "subtract", "params": [42, 23], "id": "2"},\n]\n\ndef 
test_log():\n    enabled = False\n    context = {\n        "foo": "bar",\n    }\n    movies = ["Deadpool", "Rise of
the Skywalker"]\n    console.log("Hello from", console, "!")\n    console.log(test_data, 
log_locals=True)\n\n\ntest_log()',
        'console.print(":smiley: :vampire: :pile_of_poo: :thumbs_up: :raccoon:")',
        'from rich.console import Console\nfrom rich.table import Column, Table\n\nconsole = Console()\n\ntable = 
Table(show_header=True, header_style="bold magenta")\ntable.add_column("Date", style="dim", 
width=12)\ntable.add_column("Title")\ntable.add_column("Production Budget", justify="right")\ntable.add_column("Box
Office", justify="right")\ntable.add_row(\n    "Dev 20, 2019", "Star Wars: The Rise of Skywalker", "$275,000,000", 
"$375,126,118"\n)\ntable.add_row(\n    "May 25, 2018",\n    "[red]Solo[/red]: A Star Wars Story",\n    
"$275,000,000",\n    "$393,151,347",\n)\ntable.add_row(\n    "Dec 15, 2017",\n    "Star Wars Ep. VIII: The Last 
Jedi",\n    "$262,000,000",\n    "[bold]$1,332,539,889[/bold]",\n)\n\nconsole.print(table)',
        'from rich.progress import track\n\nfor step in track(range(100)):\n    do_step(step)',
        'from rich.progress import track\ndef do_step(idx):\n    out = idx * 50\nfor step in track(range(100)):\n  
do_step(step)',
        'import os\nimport sys\n\nfrom rich import print\nfrom rich.columns import Columns\n\ndirectory = 
os.listdir(sys.argv[1])\nprint(Columns(directory))',
        "import os\nimport sys\n\nfrom rich import print\nfrom rich.columns import Columns\n\ndirectory = 
os.listdir('..)\nprint(Columns(directory))",
        "import os\nimport sys\n\nfrom rich import print\nfrom rich.columns import Columns\n\ndirectory = 
os.listdir('..')\nprint(Columns(directory))",
        "import os\nimport sys\n\nfrom rich import print\nfrom rich.columns import Columns\n\ndirectory = 
os.listdir('../..')\nprint(Columns(directory))",
        'from rich.console import Console\nfrom rich.markdown import Markdown\n\nconsole = Console()\nwith 
open("README.md") as readme:\n    markdown = Markdown(readme.read())\nconsole.print(markdown)',
        'from rich.console import Console\nfrom rich.syntax import Syntax\n\nmy_code = \'\'\'\ndef 
iter_first_last(values: Iterable[T]) -&gt; Iterable[Tuple[bool, bool, T]]:\n    """Iterate and generate a tuple 
with a flag for first and last value."""\n    iter_values = iter(values)\n    try:\n        previous_value = 
next(iter_values)\n    except StopIteration:\n        return\n    first = True\n    for value in iter_values:\n    
yield first, False, previous_value\n        first = False\n        previous_value = value\n    yield first, True, 
previous_value\n\'\'\'\nsyntax = Syntax(my_code, "python", theme="monokai", line_numbers=True)\nconsole = 
Console()\nconsole.print(syntax)',
        'from rich.console import Console\nfrom rich.markdown import Markdown\n\nconsole = Console()\nwith 
open("../../README.md") as readme:\n    markdown = Markdown(readme.read())\nconsole.print(markdown)',
        '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 
0x7fcc0cf48f90>>,
    'exit': <IPython.core.autocall.ZMQExitAutocall object at 0x7fcc0cf671d0>,
    'quit': <IPython.core.autocall.ZMQExitAutocall object at 0x7fcc0cf671d0>,
    '_': '',
    '__': '',
    '___': '',
    '_i': 'from rich.console import Console\nfrom rich.markdown import Markdown\n\nconsole = Console()\nwith 
open("../../README.md") as readme:\n    markdown = Markdown(readme.read())\nconsole.print(markdown)',
    '_ii': 'from rich.console import Console\nfrom rich.syntax import Syntax\n\nmy_code = \'\'\'\ndef 
iter_first_last(values: Iterable[T]) -&gt; Iterable[Tuple[bool, bool, T]]:\n    """Iterate and generate a tuple 
with a flag for first and last value."""\n    iter_values = iter(values)\n    try:\n        previous_value = 
next(iter_values)\n    except StopIteration:\n        return\n    first = True\n    for value in iter_values:\n    
yield first, False, previous_value\n        first = False\n        previous_value = value\n    yield first, True, 
previous_value\n\'\'\'\nsyntax = Syntax(my_code, "python", theme="monokai", line_numbers=True)\nconsole = 
Console()\nconsole.print(syntax)',
    '_iii': 'from rich.console import Console\nfrom rich.markdown import Markdown\n\nconsole = Console()\nwith 
open("README.md") as readme:\n    markdown = Markdown(readme.read())\nconsole.print(markdown)',
    '_i1': 'from rich import print\nprint("Hello, [bold magenta]World[/bold magenta]!", ":vampire:", locals())',
    'print': <function print at 0x7fcc0cf5ec00>,
    '_i2': 'from rich.console import Console\nconsole = Console()\nConsole 对象含有一个 print 方法,它的界面与 
python 内置的 print 功能相似。你可以试试:\n\nconsole.print("Hello", "World!")',
    '_i3': 'from rich.console import Console\nconsole = Console()',
    'Console': <class 'rich.console.Console'>,
    'console': <console width=115 ColorSystem.TRUECOLOR>,
    '_i4': 'console.print("Hello", "World!")',
    '_i5': 'console.print("Hello", "World!", style="bold red")',
    '_i6': 'console.print("Where there is a [bold cyan]Will[/bold cyan] there [u]is[/u] a [i]way[/i].")',
    '_i7': 'from rich.console import Console\nconsole = Console()\n\ntest_data = [\n    {"jsonrpc": "2.0", 
"method": "sum", "params": [None, 1, 2, 4, False, True], "id": "1",},\n    {"jsonrpc": "2.0", "method": 
"notify_hello", "params": [7]},\n    {"jsonrpc": "2.0", "method": "subtract", "params": [42, 23], "id": 
"2"},\n]\n\ndef test_log():\n    enabled = False\n    context = {\n        "foo": "bar",\n    }\n    movies = 
["Deadpool", "Rise of the Skywalker"]\n    console.log("Hello from", console, "!")\n    console.log(test_data, 
log_locals=True)\n\n\ntest_log()',
    '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'}
    ],
    'test_log': <function test_log at 0x7fcc0cf5e980>,
    '_i8': '>>> console.print(":smiley: :vampire: :pile_of_poo: :thumbs_up: :raccoon:")',
    '_i9': 'from rich.console import Console\nfrom rich.table import Column, Table\n\nconsole = Console()\n\ntable 
= Table(show_header=True, header_style="bold magenta")\ntable.add_column("Date", style="dim", 
width=12)\ntable.add_column("Title")\ntable.add_column("Production Budget", justify="right")\ntable.add_column("Box
Office", justify="right")\ntable.add_row(\n    "Dev 20, 2019", "Star Wars: The Rise of Skywalker", "$275,000,000", 
"$375,126,118"\n)\ntable.add_row(\n    "May 25, 2018",\n    "[red]Solo[/red]: A Star Wars Story",\n    
"$275,000,000",\n    "$393,151,347",\n)\ntable.add_row(\n    "Dec 15, 2017",\n    "Star Wars Ep. VIII: The Last 
Jedi",\n    "$262,000,000",\n    "[bold]$1,332,539,889[/bold]",\n)\n\nconsole.print(table)',
    'Column': <class 'rich.table.Column'>,
    'Table': <class 'rich.table.Table'>,
    'table': <rich.table.Table object at 0x7fcc08207d10>,
    '_i10': 'from rich.progress import track\n\nfor step in track(range(100)):\n    do_step(step)',
    'track': <function track at 0x7fcc0cf5ee80>,
    'step': 99,
    '_i11': 'from rich.progress import track\ndef do_step(idx):\n    out = idx * 50\nfor step in 
track(range(100)):\n    do_step(step)',
    'do_step': <function do_step at 0x7fcc0d88bb00>,
    '_i12': 'import os\nimport sys\n\nfrom rich import print\nfrom rich.columns import Columns\n\ndirectory = 
os.listdir(sys.argv[1])\nprint(Columns(directory))',
    'os': <module 'os' (frozen)>,
    'sys': <module 'sys' (built-in)>,
    'Columns': <class 'rich.columns.Columns'>,
    '_i13': "import os\nimport sys\n\nfrom rich import print\nfrom rich.columns import Columns\n\ndirectory = 
os.listdir('..)\nprint(Columns(directory))",
    '_i14': "import os\nimport sys\n\nfrom rich import print\nfrom rich.columns import Columns\n\ndirectory = 
os.listdir('..')\nprint(Columns(directory))",
    'directory': [
        'Untitled-Copy1.ipynb',
        'pt10_opencv2',
        'index.ipynb',
        'README.md',
        'pt11_EffectivePython',
        'pt08_nlpkl',
        'pt06_subject',
        'pt07_scicomputation',
        'pt13_Working-with-Excel-file',
        'pt01_basic',
        'pt12_Beyond-the-Basic-Stuff',
        'pt09_pygis',
        'pt05_tool',
        '.ipynb_checkpoints',
        'pt04_essential',
        'pt03_thinking'
    ],
    '_i15': "import os\nimport sys\n\nfrom rich import print\nfrom rich.columns import Columns\n\ndirectory = 
os.listdir('../..')\nprint(Columns(directory))",
    '_i16': 'from rich.console import Console\nfrom rich.markdown import Markdown\n\nconsole = Console()\nwith 
open("README.md") as readme:\n    markdown = Markdown(readme.read())\nconsole.print(markdown)',
    'Markdown': <class 'rich.markdown.Markdown'>,
    '_i17': 'from rich.console import Console\nfrom rich.syntax import Syntax\n\nmy_code = \'\'\'\ndef 
iter_first_last(values: Iterable[T]) -&gt; Iterable[Tuple[bool, bool, T]]:\n    """Iterate and generate a tuple 
with a flag for first and last value."""\n    iter_values = iter(values)\n    try:\n        previous_value = 
next(iter_values)\n    except StopIteration:\n        return\n    first = True\n    for value in iter_values:\n    
yield first, False, previous_value\n        first = False\n        previous_value = value\n    yield first, True, 
previous_value\n\'\'\'\nsyntax = Syntax(my_code, "python", theme="monokai", line_numbers=True)\nconsole = 
Console()\nconsole.print(syntax)',
    'Syntax': <class 'rich.syntax.Syntax'>,
    'my_code': '\ndef iter_first_last(values: Iterable[T]) -&gt; Iterable[Tuple[bool, bool, T]]:\n    """Iterate 
and generate a tuple with a flag for first and last value."""\n    iter_values = iter(values)\n    try:\n        
previous_value = next(iter_values)\n    except StopIteration:\n        return\n    first = True\n    for value in 
iter_values:\n        yield first, False, previous_value\n        first = False\n        previous_value = value\n  
yield first, True, previous_value\n',
    'syntax': <rich.syntax.Syntax object at 0x7fcbe9b9f1d0>,
    '_i18': 'from rich.console import Console\nfrom rich.markdown import Markdown\n\nconsole = Console()\nwith 
open("../../README.md") as readme:\n    markdown = Markdown(readme.read())\nconsole.print(markdown)',
    'readme': <_io.TextIOWrapper name='../../README.md' mode='r' encoding='UTF-8'>,
    'markdown': <rich.markdown.Markdown object at 0x7fcbe9b65790>,
    '_i19': 'from rich import print\nprint("Hello, [bold magenta]World[/bold magenta]!", ":vampire:", locals())'
}

可以看到,基于 rich 的 print 方法输出的内容都是带颜色、带重点的,相比于Python自带的 print 有明显的优势。

9.3.3. 自定义 Console 控制台输出

想要对 Rich 终端内容进行更多的自定义设置,你需要导入并构造一个控制台对象:

>>> 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.

9.3.4. Console 控制台记录

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()
[15:12:12] Hello from <console width=115 ColorSystem.TRUECOLOR> !                                  3438779683.py:16
           [                                                                                       3438779683.py:17
               {                                                                                                   
                   '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']                                                      
           ╰─────────────────────────────────────────────────╯                                                     

以上范例的输出如下:

注意其中的 log_locals 参数会输出一个表格,该表格包含调用 log 方法的局部变量。

log 方法既可用于将长时间运行应用程序(例如服务器)的日志记录到终端,也可用于辅助调试。

Logging 处理程序

你还可以使用内置的处理类来对 Python 日志记录模块的输出进行格式化和着色。下面是输出示例:

9.3.5. 表情符号

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

>>> console.print(":smiley: :vampire: :pile_of_poo: :thumbs_up: :raccoon:")
😃 🧛 💩 👍 🦝

请谨慎地使用此功能。

9.3.6. 表格

Rich 包含多种边框,样式,单元格对齐等格式设置的选项。下面是一个简单的示例:

>>> 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 │
└──────────────┴───────────────────────────────────┴───────────────────┴────────────────┘

该示例的输出如下:

请注意,控制台标记的呈现方式与 print() 和 log() 相同。实际上,由 Rich 渲染的任何内容都可以添加到标题/行(甚至其他表格)中。

Table 类很聪明,可以调整列的大小以适合终端的可用宽度,并能根据需要做文本环绕的处理。下面是相同的示例,输出与比上表小的终端上:

9.3.7. 进度条

Rich 可以渲染多个不闪烁的进度条形图,以跟踪长时间运行的任务。

基本用法:用 track 函数调用程序并迭代结果。下面是一个例子:

>>> from rich.progress import track
>>> def do_step(idx):
>>>     out = idx * 50
>>> for step in track(range(100)):
>>>     do_step(step)
Working... ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:00

添加多个进度条并不难。以下是效果示例:

动图封面 这些列可以配置为显示你所需的任何详细信息。

内置列包括完成百分比,文件大小,文件速度和剩余时间。下面是显示正在进行的下载的示例:

动图封面 它可以在显示进度的同时下载多个 URL。要自己尝试一下,请参阅示例文件中的 examples/downloader.py ,在Python实用宝典公众号后台回复 rich示例 下载全部示例。

9.3.8. 按列输出数据

Rich 可以将内容通过排列整齐的,具有相等或最佳的宽度的列来呈现。下面是(macOS / Linux) ls 命令的一个非常基本的克隆,用列来显示目录列表:

>>> import os
>>> import sys
>>>
>>> from rich import print
>>> from rich.columns import Columns
>>>
>>> directory = os.listdir('../..')
>>> print(Columns(directory))
Untitled-Copy1.ipynb        pt10_opencv2 index.ipynb         README.md                    pt11_EffectivePython
pt08_nlpkl                  pt06_subject pt07_scicomputation pt13_Working-with-Excel-file pt01_basic
pt12_Beyond-the-Basic-Stuff pt09_pygis   pt05_tool           .ipynb_checkpoints           pt04_essential
pt03_thinking

以下屏幕截图是列示例的输出,该列显示了从 API 提取的数据:

9.3.9. Markdown

Rich 可以呈现markdown,相当不错的将其格式显示到终端。

为了渲染 markdown,请导入 Markdown 类,将其打印到控制台。例子如下:

>>> 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)
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃                                                  Python notes                                                   ┃
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛

在 Jupyter 维护的 Python Notes 内容。

该例子的输出如下图:

9.3.10. 语法突出显示

Rich 使用 pygments 库来实现语法高亮显示。用法类似于渲染 markdown。构造一个 Syntax 对象并将其打印到控制台。下面是一个例子:

>>> from rich.console import Console
>>> from rich.syntax import Syntax
>>>
>>> my_code = '''
>>> def iter_first_last(values: Iterable[T]) -&gt; 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]) -&gt; 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                                                                                                               

输出如下:

9.3.11. 错误回溯(traceback)

Rich 可以渲染漂亮的错误回溯日志,比标准的 Python 回溯更容易阅读,并能显示更多代码。

你可以将 Rich 设置为默认的回溯处理程序,这样所有异常都将由 Rich 为你呈现。

下面是在 OSX(与 Linux 类似)上的外观: