日志输出附带高亮颜色-Rich python库

介绍

作为20年12月份GitHub上最热门的Python开源项目之一，可见其使用的关注度。Rich 是一个 Python 库，可以为您在终端中提供富文本和精美格式。对于开发者来说IDE使用是最频繁的工具，特别是工具的代码高亮不同颜色显示，给开发者快速分辨重要度的提示。但是对于终端输出也是开发者经常使用的工具，有效的使用工具为的是在我们开发的过程中, 能快速定位我们需要关注的内容, 也感谢那些第三方库或者插件的开发者们。
作为一个代码届的菜鸟这必须要学会啊，不管是秀还是装13（主要是实用性）所以我选择进行一个详细介绍，方便喜欢这个第三方库和我进行共同学习。

兼容性、安装与使用

兼容性

Rich 适用于 Linux，OSX 和 Windows。真彩色/表情符号可与新的 Windows 终端一起使用，Windows 的经典终端仅限 8 种颜色。

Rich 还可以与Jupyter 笔记本一起使用，而无需其他配置。

安装

作为一个python开源库，使用也是相当方便。使用pip或其他 PyPi 软件包管理器进行安装。

pip install rich
python3 -m pip install rich

不仅如此Rich API 可以很容易的在终端输出添加各种颜色和不同风格。Rich 还可以绘制漂亮的表格，进度条，markdown，突出显示语法的源代码及回溯等等，不胜枚举。

使用

以下测试皆采用 python3 的方式执行测试代码。

print()
print 函数可以以更优雅的方式输出 Python 对象, 如果你打印的对象长度不需要分行显示的话, 它将用一行的方式展示给你。

# _*_ Coding: UTF-8 _*_
from rich import print as rprint
rprint("[italic red]Hello[/italic red] World!", locals())

# _*_ Coding: UTF-8 _*_
from rich import print as rprint
rprint({
    'name': '希尔酱',
    'blog': 'https://www.youkuaiyun.com',
    'locals()': '返回当前位置全部局部变量, 并以字典的方式展示',
    'python': '一种简单直接的开发语言, 好用就对了',
})

Console终端参数介绍

如果想要对 Rich 终端内容进行更多控制，需要导入并构造一个控制台对象。

from rich.console import Console
console = Console()

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

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

你可能发现这时终端上会显示“ Hello World！”。请注意，与内置的“打印”功能不同，Rich 会将文字自动换行以适合终端宽度。
有几种方法可以为输出添加颜色和样式。您可以通过添加style关键字参数来为整个输出设置样式。例子如下：

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

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

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

控制台记录

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

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

记录处理程序

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

表情符号

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

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

表格

Rich 可以使用 Unicode 框字符来呈现多变的表格。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)

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

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

进度条

Rich 可以渲染多个不闪烁的进度条形图，以跟踪长时间运行的任务。
基本用法：用track函数调用任何程序并迭代结果。下面是一个例子：

from rich.progress import track
import  time
for step in track(range(30)):
    print('早起Python')
    time.sleep(0.5)

列

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

import os
import sys

from rich import print
from rich.columns import Columns

directory = os.listdir(sys.argv[1])
print(Columns(directory))

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

Markdown

Rich 可以呈现markdown，并可相当不错的将其格式转移到终端。
为了渲染 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)

语法突出显示：

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

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)

例子输出

回溯

Rich 可以渲染漂亮的回溯，比标准 Python 回溯更容易阅读，并能显示更多代码。您可以将 Rich 设置为默认的回溯处理程序，这样所有难以捕获的异常都将由 Rich 为您呈现。

下面是在 OSX（与 Linux 类似）上的外观：

在进行使用, 而你实例化的对象在渲染的时候将会检测以下几个属性值：

• size 是终端的当前尺寸(如果您调整窗口大小, 则可能会更改)
• encoding 是默认编码(通常为utf-8)
• is_terminal 是一个布尔值, 指示 Console 实例是否正在写入终端
• color_system 是包含控制台颜色系统的字符串
  • None 完全禁用颜色
  • auto 将自动检测颜色系统
  • standard 可以显示8种颜色, 正常和明亮的变化, 总共16种颜色
  • 256 可以显示标准中的16种颜色以及240种颜色的固定调色板
  • truecolor 可以显示1670万种颜色, 这很可能是显示器可以显示的所有颜色
    windows 在旧版 Windows 终端中可以显示8种颜色, 新的 Windows 终端可以显示 truecolor。

from rich.console import Console
console = Console()

console.print([1, 2, 3])
console.print("[blue underline]Looks like a link")
console.print(locals())
console.print("MEDUSA", style="white on blue")

写在最后

rich 的功能很强大, 支持 console 直接输出, 支持 log 输出, 也支持 file 文件写入等方式, 还有表格输出等等, 如果你想进一步学习这个库, 建议你移步 Rich 的官方使用文档, 这个世界没有什么比官方文档更加具体的文档了。