如何配置Jupyter自动展示带_repr_html_装饰器的已定义函数？

问题描述 #

我有一个装饰器add_repr_html，它会为对象添加_repr_html_方法，并用它修饰函数foo：

def add_repr_html(f):
    f._repr_html_ = lambda: f"This is {f.__name__}!"
    return f

@add_repr_html
def foo():
    ...

如果代码单元格只包含上述内容，Jupyter不会显示任何内容；但如果在单元格末尾单独添加一行foo，就会显示"This is foo!"。

请问是否可以配置Jupyter，无需额外添加foo这一行，就能自动调用_repr_html_方法展示该函数？（注：这只是示例场景，实际中装饰器会实例化带有_repr_html_方法的类。）

解决方案 #

Jupyter默认仅会渲染单元格最后一个表达式的返回结果，函数定义属于语句，不会触发自动输出。以下是几种可行的实现方式：

1. 修改装饰器主动触发显示（推荐） #

借助IPython的display函数，在装饰器完成对象修饰后，主动调用该函数渲染带有_repr_html_的对象。这种方式无需修改Jupyter全局配置，且仅对被装饰的对象生效，可控性强。

修改后的代码示例：

from IPython.display import display

def add_repr_html(f):
    f._repr_html_ = lambda: f"This is {f.__name__}!"
    display(f)  # 主动触发HTML渲染
    return f

@add_repr_html
def foo():
    ...

执行包含上述代码的单元格时，装饰器会自动调用display，直接展示foo的HTML表示，无需额外添加foo行。

2. 自定义IPython魔法命令（进阶） #

如果不想修改装饰器，可以编写自定义魔法命令，通过解析单元格的抽象语法树（AST），自动识别被add_repr_html装饰的对象并调用display。不过这种方法需要熟悉IPython魔法命令的开发流程，复杂度较高，适合有定制化需求的场景。

3. 修改Jupyter全局执行行为（不推荐） #

Jupyter的核心执行逻辑是仅输出最后一个表达式的结果，若要全局改变这一行为，需要修改IPython的配置文件，但这会导致所有单元格的语句都可能触发输出，容易产生冗余内容，因此不建议采用。

内容的提问来源于stack exchange，提问作者wch