如何让VSCode Python调试器为自定义类支持「在数据查看器中查看值」

问题原因 #

• 继承collections.abc.Sequence的自定义类：VSCode调试器默认不会将其识别为可在数据查看器中展示的结构化数据类型，仅内置/常用库的特定类型（如numpy数组、pandas DataFrame）会默认触发该选项。
• 继承np.ndarray的类：你当前的实现未遵循numpy子类的正确构造逻辑，导致调试器无法将实例识别为numpy数组类型。

可行实现方案 #

方案一：正确实现numpy数组子类 #

numpy的子类需要通过__new__方法创建实例（而非仅依赖__init__），这样调试器才能识别其为numpy数组，从而显示查看器选项：

import numpy as np

class Y(np.ndarray):
    def __new__(cls, input_array):
        # 将输入数组转换为当前子类的实例
        obj = np.asarray(input_array).view(cls)
        return obj

an_array = np.array([1, 2, 3])
an_instance_of_Y = Y(an_array)  # 右键可触发「在数据查看器中查看值」

方案二：为自定义类实现__debugpy_display__方法 #

VSCode的Python调试器基于debugpy，支持通过__debugpy_display__方法自定义变量的可视化逻辑。返回符合格式的结构后，调试器会自动触发数据查看器选项：

from collections.abc import Sequence
import numpy as np

class X(Sequence):
    _x: np.ndarray

    def __init__(self, x: np.ndarray):
        self._x = x

    def __getitem__(self, index):
        return self._x[index]

    def __len__(self):
        return len(self._x)

    def __contains__(self, value):
        return value in self._x

    def __iter__(self):
        return iter(self._x)

    def __debugpy_display__(self):
        # 返回调试器可解析的数组结构
        return {
            "type": "array",
            "value": self._x.tolist(),
            "shape": self._x.shape,
            "dtype": str(self._x.dtype)
        }

an_instance_of_X = X(np.array([1, 2, 3]))  # 右键可触发查看器选项

补充说明 #

__debugpy_display__方法的返回结构可根据需求调整：

• 若要模拟表格结构（类似pandas DataFrame），可返回包含columns和data的字典
• 基础的数组结构只需指定type为array，并提供value（列表形式的数组内容）即可

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