ruamel.yaml无法表示np.array对象的问题求助（Pydantic场景）

报错信息 #

File "/usr/local/lib/python3.10/site-packages/ruamel/yaml/representer.py", line 337, in represent_undefined
    raise RepresenterError(f'cannot represent an object: {data!s}')
ruamel.yaml.representer.RepresenterError: cannot represent an object: [0 0 0 0]

问题场景 #

模型字段定义如下，默认值为np.ndarray对象：

std: Optional[np.ndarray] = np.array([1.0, 1.0, 1.0, 1.0])
mean: Optional[np.ndarray] = np.array([0, 0, 0, 0])

曾尝试将默认值改为普通列表，但后续代码要求这两个字段必须是np.array类型。

可行解决方案 #

方案1：给ruamel.yaml注册np.ndarray序列化器 #

直接让ruamel.yaml学会序列化np.ndarray对象，自动将其转为普通列表处理：

import ruamel.yaml
import numpy as np

def represent_np_array(dumper, data):
    return dumper.represent_sequence('tag:yaml.org,2002:seq', data.tolist())

ruamel.yaml.add_representer(np.ndarray, represent_np_array)

优点：全局生效，无需修改模型定义，默认值保持np.array，后续代码可直接使用。

方案2：结合Pydantic字段验证与自定义序列化 #

在模型中确保字段始终为np.ndarray，同时序列化时转为列表：

from pydantic import BaseModel, field_validator
from typing import Optional
import numpy as np

class YourConfigModel(BaseModel):
    std: Optional[np.ndarray] = np.array([1.0, 1.0, 1.0, 1.0])
    mean: Optional[np.ndarray] = np.array([0, 0, 0, 0])

    @field_validator('std', 'mean', mode='before')
    def convert_to_np(cls, value):
        if isinstance(value, list):
            return np.array(value)
        return value

    class Config:
        json_encoders = {
            np.ndarray: lambda arr: arr.tolist()
        }

序列化时先通过model_dump()转成可处理的字典，再用ruamel.yaml输出：

model_instance = YourConfigModel()
yaml_content = ruamel.yaml.dump(model_instance.model_dump())

优点：仅针对当前模型生效，不影响全局ruamel.yaml配置。

方案3：使用default_factory避免可变默认值风险 #

如果担心np.array作为默认值的可变对象风险（比如多个实例共享同一数组），可以用default_factory初始化：

from pydantic import BaseModel, Field
from typing import Optional
import numpy as np

class YourConfigModel(BaseModel):
    std: Optional[np.ndarray] = Field(default_factory=lambda: np.array([1.0, 1.0, 1.0, 1.0]))
    mean: Optional[np.ndarray] = Field(default_factory=lambda: np.array([0, 0, 0, 0]))

配合方案1的ruamel.yaml序列化器使用，既解决序列化问题，又避免可变默认值的潜在bug。

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