如何在IPython中实现对象顶层与嵌套时的差异化美观打印？

在IPython中，我们可以通过实现__repr_pretty__方法自定义对象的美观打印形式，示例代码如下：

class MyObject:
    def __repr_pretty__(self, p, cycle):
        p.text("<MyObject: object content>")

但上述实现存在问题：在Shell顶层调用MyObject()时会输出完整描述，可如果多个该对象嵌套在列表、字典等结构中，输出内容会过于冗长，干扰用户查看核心结构。

需求 #

• 当MyObject()处于顶层时，显示完整描述
• 当MyObject()处于嵌套结构中时，显示简化的<MyObject: ...>

理由：嵌套时过多细节会干扰用户对整体结构的判断，若需查看单个对象详情，用户可直接通过list[0]这类方式单独调用对象。

实现方案 #

我们可以在__repr_pretty__方法中判断当前打印上下文（是否处于顶层），以此切换不同输出内容。同时实现__repr__作为简化版本的 fallback，确保非IPython环境也能正常显示简化信息。

具体代码如下：

class MyObject:
    def __repr__(self):
        # 简化版本，作为嵌套或非IPython环境的默认输出
        return "<MyObject: ...>"

    def __repr_pretty__(self, p, cycle):
        if cycle:
            # 处理循环引用，避免无限递归
            p.text(repr(self))
            return
        
        # 通过当前缩进量判断是否为顶层打印
        if p.current_indent == 0:
            # 顶层时输出完整描述
            p.text("<MyObject: object content>")
        else:
            # 嵌套时输出简化版本
            p.text(repr(self))

方案说明 #

1. __repr__方法：定义对象的简化字符串表示，既作为嵌套打印时的输出内容，也作为非IPython环境的默认显示。
2. __repr_pretty__方法：
   • 先处理循环引用场景（cycle为True时），直接输出简化版本避免递归死循环。
   • 通过p.current_indent判断打印层级：IPython打印顶层对象时缩进量为0，嵌套在容器中时缩进量大于0，此时切换为简化输出。

更优思路 #

如果需要更灵活的层级控制（比如自定义嵌套深度阈值），可以借助IPythonPrettyPrinter的内部_depth属性（实际使用中稳定），当嵌套深度大于0时输出简化内容：

class MyObject:
    def __repr__(self):
        return "<MyObject: ...>"

    def __repr_pretty__(self, p, cycle):
        if cycle:
            p.text(repr(self))
            return
        
        # 通过打印深度判断是否嵌套
        if p._depth == 0:
            p.text("<MyObject: object content>")
        else:
            p.text(repr(self))

这种方式比判断缩进更直接，因为嵌套时p._depth会递增，顶层时为0。

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