为Django模型管理器自定义方法实现动态类型注解

我完全懂你的痛点——自定义的get_or_none方法现在返回的类型是抽象基类BaseModel | None，但你希望它能像Django默认的get/filter那样，自动识别具体的子类（比如MyModel），返回MyModel | None的类型提示。其实只要给管理器加上泛型类型注解，就能解决这个问题，让类型系统正确关联到具体的模型子类。

下面是具体的修改步骤和完整代码：

1. 导入必要的类型工具 #

首先需要导入泛型相关的类型，如果你用的是Python 3.11+，可以直接从typing导入TypeVar、Generic和Self；如果是Python 3.10及以下，需要从typing_extensions导入Self：

from django.db import models
import uuid
# Python 3.11+ 用这个导入
from typing import TypeVar, Generic, Self
# Python 3.10及以下替换成：
# from typing import TypeVar, Generic
# from typing_extensions import Self

2. 给BaseManager添加泛型绑定 #

定义一个绑定到models.Model的类型变量，然后让BaseManager继承Generic[T]，这样它就能关联到具体的模型类型。同时给get_or_none方法指定返回类型为T | None：

# 定义类型变量，绑定到Django模型类
T = TypeVar('T', bound=models.Model)

class BaseManager(models.Manager, Generic[T]):
    def get_or_none(self, *args, **kwargs) -> T | None:
        try:
            # 这里self.get()的返回类型会被自动推断为T
            return self.get(*args, **kwargs)
        except self.model.DoesNotExist:
            return None

3. 给BaseModel的objects指定泛型类型 #

在抽象基类BaseModel中，用Self类型来标注objects，这样当子类继承时，Self会自动替换为子类本身的类型：

class BaseModel(models.Model):
    id = models.UUIDField(
        primary_key=True, default=uuid.uuid4, verbose_name="ID", editable=False
    )
    created_at = models.DateTimeField(auto_now_add=True)
    updated_at = models.DateTimeField(auto_now=True)

    # 用Self指定管理器关联的模型类型，子类继承时会自动替换为子类类型
    objects: BaseManager[Self] = BaseManager()

    class Meta:
        abstract = True

4. 验证效果 #

现在你的MyModel不需要做任何修改：

class MyModel(BaseModel):
    category = models.CharField(max_length=10)

当你调用MyModel.objects.get_or_none()时，IDE的类型提示就会正确显示：

my_object: MyModel | None = MyModel.objects.get_or_none(category="...")

为什么这样有效？ #

Django的默认管理器方法（比如get、filter）本身就是用泛型实现的，它们能动态关联到具体的模型类型。我们通过给自定义管理器添加泛型绑定，再用Self类型让抽象基类的objects属性在子类中自动关联到子类本身，就实现了和默认方法一样的动态类型提示效果。

如果你的项目还在使用Python 3.9及以下版本，记得把T | None替换成Union[T, None]（需要从typing导入Union）。

备注：内容来源于stack exchange，提问作者Nahidujjaman Hridoy