Pygments格式化器:定义你的代码显示规则

Pygments是一个用于语法高亮的Python库。它支持超过500种不同的编程语言和文件格式，并提供了一个灵活的格式化器，用于自定义代码的显示规则。

下面是一个使用Pygments进行代码高亮的例子：

from pygments import highlight
from pygments.lexers import get_lexer_by_name
from pygments.formatters import HtmlFormatter

code = """
def fibonacci(n):
    if n <= 0:
        return []
    elif n == 1:
        return [0]
    elif n == 2:
        return [0, 1]
    else:
        fib = [0, 1]
        for _ in range(2, n):
            fib.append(fib[-1] + fib[-2])
        return fib

print(fibonacci(10))
"""

lexer = get_lexer_by_name("python")
formatter = HtmlFormatter()
highlighted_code = highlight(code, lexer, formatter)

with open("highlighted_code.html", "w") as file:
    file.write(f"<style>{formatter.get_style_defs('.highlight')}</style>")
    file.write(highlighted_code)

在上面的例子中，我们首先导入了必要的Pygments模块。然后，我们定义了一段Python代码，该代码实现了一个斐波那契数列的生成函数。接下来，我们通过调用get_lexer_by_name方法获取Python语言的词法分析器。然后，我们创建了一个HTML格式化器，并调用highlight方法对代码进行高亮处理。最后，我们将高亮处理后的代码写入到一个HTML文件中。

在以上代码中，我们使用了默认的高亮样式和默认的HTML格式化选项。但是，Pygments支持很多自定义选项，例如：

- 设置不同语法元素的前景色和背景色

- 设置不同语法元素的字体样式

- 设置整体代码块的背景色和边框样式

- 自定义行号的显示方式

- 自定义缩进和空白字符的处理方式

- 支持输出为HTML、RTF、LaTeX等多种格式

可以通过创建自定义的格式化器类来实现这些选项的自定义。以下是一个示例，展示如何创建一个自定义的HTML格式化器，将不同类型的语法元素用不同的颜色表示：

from pygments.formatters import HtmlFormatter

class CustomHtmlFormatter(HtmlFormatter):
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.colors = {
            "Keyword": "#ff0000",   # 关键字
            "Name": "#00ff00",      # 变量名
            "Number": "#0000ff",    # 数字
            "Comment": "#808080",   # 注释
        }
    
    def wrap(self, source, outfile):
        return self._wrap_code(source)
    
    def _wrap_code(self, source):
        for i, t in source:
            if i == 1:
                yield f"<span style='color:{self.colors[t]}'>", "</span>"
            yield t

在上述代码中，我们创建了一个自定义的CustomHtmlFormatter类，继承自HtmlFormatter。我们重写了wrap方法，将其中的_wrap_code方法调用改为我们自定义的_wrap_code方法。在_wrap_code方法中，我们使用了一个自定义的颜色字典，根据语法元素的类型来设置代码片段的颜色。

要使用自定义的格式化器，只需将其实例传递给highlight方法即可：

highlighted_code = highlight(code, lexer, CustomHtmlFormatter())

通过使用自定义的格式化器，我们可以根据自己的需求对代码进行更精细的控制和显示。Pygments提供了丰富的选项和功能，使我们能够根据需求定制代码的显示规则，以便更好地突出代码的结构和语法。