python-sphinx - Sphinx Pygments lexer过滤器扩展？

我有一种类似Lisp的语言，我想在Sphinx代码片段文档中使用Pygments进行突出显示。我的方法是扩展现有的CommonLispLexer以使用NameHighlightFilter添加内置名称。但是，它不起作用，因此我必须缺少明显的东西。我在conf.py中添加了以下内容:

def setup(app):
    from sphinx.highlighting import lexers
    from pygments.lexers import CommonLispLexer
    from pygments.token import Name
    from pygments.filters import NameHighlightFilter
    tl_lexer = CommonLispLexer()
    tl_lexer.add_filter(NameHighlightFilter(
            names=['define-function', 'define-macro',
                   'define-variable', 'define-constant'],
            tokentype=Name.Builtin,
            ))
    app.add_lexer('tl', tl_lexer)

highlight_language = 'tl'

但是NameHighlightFilter无效。代码块就像Lisp一样被突出显示，但是我的新内置名称没有特殊的突出显示。

最佳答案

原因是NameHighlighFilter仅转换词法分析器归类为Token.Name的 token ，但CommonLispLexer几乎将所有内容归类为Name.Variable。这是来自Pygments源代码的NameHighlightFilter的过滤器功能:

def filter(self, lexer, stream):
    for ttype, value in stream:
        if ttype is Name and value in self.names:
            yield self.tokentype, value
        else:
            yield ttype, value

我唯一的解决方法是编写自己的过滤器。这个功能给了我想要的外观。

def filter(self, lexer, stream):
    define = False
    for ttype, value in stream:
        if value in self.tl_toplevel_forms:
            ttype = Name.Builtin
            define = True
        elif define and ttype == Name.Variable:
            define = False
            ttype = Name.Function
        elif value in self.tl_special_forms:
            ttype = Name.Variable
        # the Common Lisp lexer highlights everything else as
        # variables, which isn't the look I want.  Instead
        # highlight all non-special things as text.
        elif ttype == Name.Variable:
            ttype = Name.Text
        yield ttype, value

作为对Pygments开发人员的说明，也许NameHighlightFilter可以接受一个可选参数，表示要转换的 token 类型(当前仅接受输出 token 类型)。