python 自定义类to_dict

### 创建自定义类并实现 `to_dict` 方法

为了创建一个能够将其实例转换为字典形式的自定义类，在 Python 中可以通过多种方式实现这一目标。一种常见的方式是在类内部定义一个名为 `to_dict` 的方法，该方法返回表示对象状态的一个字典。

#### 使用内置属性 `__dict__`

Python 类实例拥有一个特殊的属性 `__dict__` ，它存储着实例的所有可变属性及其对应的值。可以利用这一点快速构建 `to_dict` 方法[^2]：

class Person:
    def __init__(self, name, age):
        self.name = name
        self.age = age
    
    def to_dict(self):
        return self.__dict__

这种方法简单直接，适用于大多数情况下不需要额外处理的情况。

#### 手动指定要包含的字段

如果希望更精确地控制哪些数据应该被包含在最终生成的字典中，则可以选择手动组装这个字典而不是依赖于 `__dict__` 。这允许排除某些敏感信息或仅导出特定的数据成员。

class Employee:
    def __init__(self, id, first_name, last_name, salary):
        self.id = id
        self.first_name = first_name
        self.last_name = last_name
        self.salary = salary
        
    def to_dict(self):
        employee_data = {
            "id": self.id,
            "full_name": f"{self.first_name} {self.last_name}",
            "salary": str(self.salary) + "$"
        }
        return employee_data

在这个例子中，不仅选择了部分原始属性作为键值对加入到新字典里，还进行了简单的格式化操作以增强输出效果。

#### 结合外部库（如 Peewee ORM）

对于那些基于数据库模型设计的应用程序来说，可能已经存在一些辅助工具可以帮助完成这项工作。例如Peewee ORM提供了 `model_to_dict()` 函数用于将模型实体转化为字典结构[^4]:

假设有一个继承自 peewee.Model 的 User 表示用户表单中的条目:

from peewee import Model, CharField, IntegerField

class User(Model):
    username = CharField()
    password_hash = CharField()  # 敏感信息不对外公开
    email = CharField(unique=True)
    
def user_to_safe_dict(user_model):
    safe_user_info = model_to_dict(
        user_model,
        only=[User.username, User.email],
        exclude=[User.password_hash]
    )
    return safe_user_info

这里通过设置 `only` 和 `exclude` 参数指定了哪些字段应当出现在结果集中以及哪些不应该出现。