Tortoise-ORM 中使用 only() 方法导致的 AttributeError 问题分析

问题背景

在使用 Tortoise-ORM 进行数据库查询时，开发者可能会遇到一个特定场景下的异常问题。当使用 only() 方法限制查询字段后，尝试打印查询结果对象时，会抛出 AttributeError: 'ModelResults' object has no attribute 'id' 错误。这个问题看似简单，但实际上涉及 ORM 框架的内部机制和 Python 对象表示方式的交互。

问题复现

让我们通过一个具体的模型定义和查询示例来重现这个问题：

class ModelResults(Model):
    id = fields.IntField(pk=True)
    score = fields.FloatField(default=0, description="评测分数")
    total = fields.IntField(description="总用例数")
    # 其他字段省略...
    
    class Meta:
        table = "tb_model_results"

# 问题查询代码
res = await ModelResults.filter(ai_model=ai_model).only("score", "major_type").all()
print(res)  # 这里会抛出异常

问题根源分析

这个问题的根本原因在于 Tortoise-ORM 的两个设计特性的交互：

1. only() 方法的行为：only() 方法用于优化查询，只从数据库获取指定的字段。在这个例子中，虽然模型定义了 id 作为主键字段，但 only("score", "major_type") 明确告诉 ORM 不要获取 id 字段。

2. __repr__ 方法的实现：Tortoise-ORM 的基类 Model 实现了 __repr__ 方法，用于对象的字符串表示。这个方法内部会尝试访问主键值 (self.pk)，而 pk 属性又通过 _get_pk_val() 方法获取，最终会尝试访问模型的主键字段（在这个例子中是 id）。

当这两个特性结合时，就产生了矛盾：only() 排除了 id 字段，但 __repr__ 又需要访问它，导致 AttributeError。

技术细节

深入查看 Tortoise-ORM 的源码，我们可以找到问题的具体位置：

def _get_pk_val(self) -> Any:
    return getattr(self, self._meta.pk_attr)  # 这里尝试获取主键属性

当 only() 排除了主键字段后，这个 getattr 调用就会失败，因为请求的属性不存在于部分加载的模型中。

解决方案

这个问题已经在 Tortoise-ORM 的 #1724 PR 中修复。修复方案主要考虑了以下几点：

1. 防御性编程：在 __repr__ 方法中处理部分加载模型的情况。
2. 向后兼容：确保修改不会影响现有代码的行为。
3. 明确性：在对象表示中清楚地表明这是一个部分加载的模型。

对于开发者来说，在等待新版本发布期间，可以采取以下临时解决方案：

1. 避免直接打印部分加载的 QuerySet：先转换为列表或处理数据后再打印。
2. 自定义 __repr__ 方法：在模型中覆盖默认的 __repr__ 实现。
3. 确保包含主键字段：即使使用 only()，也始终包含主键字段。

最佳实践建议

基于这个问题的分析，我们总结出一些使用 Tortoise-ORM 的最佳实践：

1. 谨慎使用 only()：明确了解 only() 的副作用，特别是在需要完整对象功能的场景。
2. 主键字段的重要性：大多数 ORM 操作都依赖主键，除非有充分理由，否则不要排除它。
3. 对象表示的考虑：当设计模型时，要考虑各种使用场景下的对象表示需求。
4. 异常处理：在对 ORM 对象进行操作时，适当处理可能出现的属性缺失情况。

总结

这个问题展示了 ORM 框架中查询优化与对象表示之间的微妙交互。通过分析这个问题，我们不仅理解了 Tortoise-ORM 的内部工作机制，也学到了如何更安全地使用 ORM 的高级功能。作为开发者，在使用类似 only() 这样的优化方法时，应该充分了解其限制和潜在影响，以编写更健壮的代码。