在debugpy中自定义PyTorch张量的调试显示格式

在Python调试过程中，特别是使用PyTorch进行深度学习开发时，我们经常需要查看张量(Tensor)的形状信息。默认情况下，调试器会显示张量的完整内容，这在处理大型张量时会显得非常冗长且不便于快速获取关键信息。

问题背景

当使用debugpy进行调试时，PyTorch张量在变量查看窗口中会显示全部内容。对于大型张量，这会带来两个问题：

1. 显示内容过于冗长，难以快速定位关键信息
2. 实际开发中，我们通常更关心张量的形状(shape)和设备(device)信息，而不是具体数值

解决方案

我们可以通过自定义PyTorch张量的__repr__方法来改变其在调试器中的显示方式。__repr__是Python中用于获取对象"官方"字符串表示的方法，调试器会使用这个方法来显示对象。

以下是一个改进后的实现方案：

import torch

# 保存原始的__repr__方法
torch_original_repr = torch.Tensor.__repr__

def torch_custom_repr(self):
    """自定义张量显示格式，突出显示形状和设备信息"""
    shape_info = f"形状: {tuple(self.shape)}"
    device_info = f"设备: {self.device}"
    return f"{shape_info}\n{device_info}\n[详细内容已隐藏...]"

# 替换默认的__repr__方法
torch.Tensor.__repr__ = torch_custom_repr

实现效果

应用上述修改后，调试器中的张量显示将变得更加简洁：

• 第一行显示张量形状
• 第二行显示所在设备(CPU/GPU)
• 最后一行提示详细内容已隐藏

这种显示方式特别适合以下场景：

• 快速检查模型各层输出的形状是否正确
• 确认张量是否按预期转移到了指定设备上
• 在调试大型模型时减少视觉干扰

注意事项

1. 这种修改是全局性的，会影响所有PyTorch张量的显示方式
2. 如果需要查看详细内容，可以临时注释掉自定义的__repr__方法
3. 在某些IDE中，可能需要重启调试会话才能使修改生效
4. 此方法不会影响张量的子属性显示方式

扩展应用

类似的技巧也可以应用于其他科学计算库，如NumPy数组。只需替换相应类的__repr__方法即可实现自定义显示格式。

通过这种简单的定制，我们可以显著提高深度学习开发中的调试效率，特别是在处理复杂模型和大规模数据时。