Python Module — rich CLI 富文本库

旧城等待， 2023-10-08 22:29 19阅读 0赞

## 目录 ##

#### 文章目录 ####

*  目录
 *  rich 库
 *  实例化
 *  美化输出
 *  美化表格
 *  美化列输出
 *  美化进度条
 *  美化 Markdown 文档
 *  美化代码高亮
 *  美化异常追踪
 *  美化日志输出

## rich 库 ##

Rich 是一个用于在终端和命令行界面中显示富文本的 Python 库。它可以帮助开发者在终端中渲染各种文本样式、颜色和布局，并支持在表格、面板、进度条等控件中展示数据。使用 Python Rich，开发者可以创建交互式的终端应用程序、漂亮的报告和文档，提高用户体验和可读性。

Python Rich 支持各种文本样式，如加粗、斜体、下划线、删除线、高亮等，也支持不同的颜色、背景色和标记符号。此外，Python Rich 还支持自定义样式和主题，让用户可以根据自己的需求定制外观和风格。

Python Rich 还提供了丰富的控件，如表格、面板、进度条、树形结构等，让开发者可以更方便地展示和组织数据。同时，Python Rich 还支持在终端中播放音频和视频，以及在终端中绘制图形。

总的来说，Python Rich 是一个非常实用和强大的终端美化库，可以让开发者更方便地开发交互式的终端应用程序，提高用户体验和可读性。

## 实例化 ##

from rich.console import Console
    
    console = Console()

## 美化输出 ##

console.print("Where there is a [bold cyan]Will[/bold cyan] there [u]is[/u] a [i]way[/i].")
    console.print("Hello, [bold magenta]World[/bold magenta]!", ":vampire:")
    console.print(":smiley: :vampire: :pile_of_poo: :thumbs_up: :raccoon:")

效果：颜色高亮、下划线、加粗、表情。  
![在这里插入图片描述][8964662cbb274a068a95b3d55f8bc935.png]

## 美化表格 ##

from rich.table import Column, Table
    
    
    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)

效果：  
![在这里插入图片描述][9b8196b606954673884daab7d63b4d5b.png]

## 美化列输出 ##

from rich.console import Console
    from rich.columns import Columns
    from rich.panel import Panel
    
    console = Console()
    
    left_panel = Panel("Left panel", title="Panel 1")
    right_panel = Panel("Right panel", title="Panel 2")
    
    columns = Columns([left_panel, right_panel], equal=True)
    
    console.print(columns)

效果：  
![在这里插入图片描述][435e3096fca044a6a6a78c4295f36ad2.png]

## 美化进度条 ##

from rich.progress import track
    
    for step in track(range(100)):
        pass

效果：  
![在这里插入图片描述][8e88d7ae479b435694a2c2af4acc0b4e.png]

## 美化 Markdown 文档 ##

from rich.markdown import Markdown
    
    with open("README.md") as readme:
        markdown = Markdown(readme.read())
    console.print(markdown)

效果：  
![在这里插入图片描述][c4a98a8f00b44323b0edad89c29f3e9c.png]

## 美化代码高亮 ##

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.print(syntax)

效果：  
![在这里插入图片描述][cb81a22a6bf343e4a3cff87c84cbea3b.png]

## 美化异常追踪 ##

import rich.traceback
    rich.traceback.install()
    
    a = 1 / 0

![在这里插入图片描述][944de3534b7d4e3da0df528688134d1d.png]

## 美化日志输出 ##

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()

效果：  
![在这里插入图片描述][a8ecb4c2deb14d4d8465d87e4ae5d77f.png]

[8964662cbb274a068a95b3d55f8bc935.png]: https://img-blog.csdnimg.cn/8964662cbb274a068a95b3d55f8bc935.png
[9b8196b606954673884daab7d63b4d5b.png]: https://img-blog.csdnimg.cn/9b8196b606954673884daab7d63b4d5b.png
[435e3096fca044a6a6a78c4295f36ad2.png]: https://img-blog.csdnimg.cn/435e3096fca044a6a6a78c4295f36ad2.png
[8e88d7ae479b435694a2c2af4acc0b4e.png]: https://img-blog.csdnimg.cn/8e88d7ae479b435694a2c2af4acc0b4e.png
[c4a98a8f00b44323b0edad89c29f3e9c.png]: https://img-blog.csdnimg.cn/c4a98a8f00b44323b0edad89c29f3e9c.png
[cb81a22a6bf343e4a3cff87c84cbea3b.png]: https://img-blog.csdnimg.cn/cb81a22a6bf343e4a3cff87c84cbea3b.png
[944de3534b7d4e3da0df528688134d1d.png]: https://img-blog.csdnimg.cn/944de3534b7d4e3da0df528688134d1d.png
[a8ecb4c2deb14d4d8465d87e4ae5d77f.png]: https://img-blog.csdnimg.cn/a8ecb4c2deb14d4d8465d87e4ae5d77f.png