Python控制台加载YAML文件无法找到关联类，如何指定仅用类名加载？

问题根源 #

默认情况下，PyYAML序列化类实例时会写入完整的模块路径（比如__main__.MyClass）。命令行运行脚本时，__main__就是定义MyClass的模块，所以加载正常；但在Python控制台中，__main__是控制台自身的模块，不存在MyClass，因此抛出找不到类的错误。

解决方案 #

方案1：自定义YAML序列化/反序列化逻辑，仅使用类名

通过自定义representer和constructor，让PyYAML保存时只记录类名，加载时根据类名匹配对应的类。这种方式不依赖模块路径，适用于类仅在当前上下文使用的场景。

修改后的代码示例：

import tempfile
from pathlib import Path
import yaml

class MyClass:
    def __init__(self, attribute):
        self.attribute = attribute

# 自定义序列化器：输出类名作为标识
def myclass_representer(dumper, instance):
    return dumper.represent_mapping(f'!{instance.__class__.__name__}', {
        'attribute': instance.attribute
    })

# 自定义反序列化器：根据类名构造实例
def myclass_constructor(loader, node):
    attrs = loader.construct_mapping(node)
    return MyClass(**attrs)

# 注册自定义逻辑到PyYAML
yaml.add_representer(MyClass, myclass_representer)
yaml.add_constructor('!MyClass', myclass_constructor)

if __name__=='__main__':
    my_instance = MyClass(attribute="Hello World")

    with tempfile.TemporaryDirectory() as tmpdir:
        save_path = Path(tmpdir) / 'my_save.yaml'
        # 保存实例
        with open(save_path, 'w') as f:
            yaml.dump(my_instance, f)
        # 加载实例
        with open(save_path, 'r') as f:
            my_instance_loaded = yaml.load(f, Loader=yaml.UnsafeLoader)
        
        print(my_instance_loaded.attribute)  # 输出: Hello World

生成的YAML内容会是：

!MyClass {attribute: Hello World}

方案2：将类移至独立模块（推荐）

把类定义放到单独的Python模块中，这样序列化时PyYAML会写入固定的模块路径（比如my_module.MyClass），只要加载环境能导入该模块，就能正常加载实例。这种方式更规范，适合项目级使用，避免类名冲突。

步骤如下：

1. 创建my_module.py文件：

class MyClass:
    def __init__(self, attribute):
        self.attribute = attribute

2. 主脚本代码：

import tempfile
from pathlib import Path
import yaml
from my_module import MyClass

if __name__=='__main__':
    my_instance = MyClass(attribute="Hello World")

    with tempfile.TemporaryDirectory() as tmpdir:
        save_path = Path(tmpdir) / 'my_save.yaml'
        # 保存实例
        with open(save_path, 'w') as f:
            yaml.dump(my_instance, f)
        # 加载实例
        with open(save_path, 'r') as f:
            my_instance_loaded = yaml.load(f, Loader=yaml.UnsafeLoader)
        
        print(my_instance_loaded.attribute)  # 输出: Hello World

此时生成的YAML内容为：

!!python/object:my_module.MyClass {attribute: Hello World}

方案对比 #

• 方案1：无需额外模块，适合快速测试或小型脚本，但如果存在多个同名类会导致冲突，需要手动维护类名映射。
• 方案2：结构清晰，可维护性强，是项目中推荐的做法，确保类的路径统一，避免加载时的模块依赖问题。

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