如何为类方法加类型提示：仅允许子类调用并返回子类实例

问题描述 #

现有类结构如下：
父类代码：

class Parent:
    _GET_URL = None

    @classmethod
    def get_object(cls) -> typing.Self:
        requests.get(cls._GET_URL)

子类代码：

class Child(Parent):
    _GET_URL = "https://some-url-to-child.me"

所有子类均配置了专属URL，需实现两个类型提示相关需求：

1. 限制get_object方法仅能被子类调用，确保使用子类的URL获取对象；
2. 让代码检查器（如PyCharm）识别Child.get_object()的返回值为Child类型，而非Parent类型。

尝试过typing.Self和ChildObject = TypeVar('ChildObject', bounds="Parent")均未成功，尤其不知如何实现第一个需求。

解决方案 #

需求1：限制get_object仅被子类调用 #

在get_object方法中加入运行时检查，同时通过类型提示强化约束：

import typing
import requests

class Parent:
    _GET_URL = None

    @classmethod
    def get_object(cls: typing.Type[typing.Self]) -> typing.Self:
        # 运行时拦截父类直接调用
        if cls is Parent:
            raise NotImplementedError("get_object方法仅能由Parent的子类调用")
        # 确保子类已配置有效URL
        if not cls._GET_URL:
            raise ValueError("子类必须配置有效的_GET_URL属性")
        response = requests.get(cls._GET_URL)
        # 示例：返回子类实例，可根据实际业务逻辑调整
        return cls()

class Child(Parent):
    _GET_URL = "https://some-url-to-child.me"

通过typing.Type[typing.Self]明确调用者必须是Parent的子类类型，同时运行时检查直接阻止Parent.get_object()的非法调用。

需求2：让代码检查器识别子类返回类型 #

• Python 3.11+版本：直接使用typing.Self即可让代码检查器正确推断子类返回类型，无需额外配置。
• Python 3.10及以下版本：使用TypeVar结合Generic实现类型推断：

from typing import TypeVar, Generic, Type
import requests

T = TypeVar('T', bound='Parent')

class Parent(Generic[T]):
    _GET_URL = None

    @classmethod
    def get_object(cls: Type[T]) -> T:
        if cls is Parent:
            raise NotImplementedError("get_object方法仅能由Parent的子类调用")
        if not cls._GET_URL:
            raise ValueError("子类必须配置有效的_GET_URL属性")
        requests.get(cls._GET_URL)
        return cls()

class Child(Parent['Child']):
    _GET_URL = "https://some-url-to-child.me"

此时PyCharm等工具会正确识别Child.get_object()的返回值为Child类型。

最终整合版本（Python 3.11+） #

import typing
import requests

class Parent:
    _GET_URL = None

    @classmethod
    def get_object(cls: typing.Type[typing.Self]) -> typing.Self:
        if cls is Parent:
            raise NotImplementedError("get_object方法仅能由Parent的子类调用")
        if not cls._GET_URL:
            raise ValueError("子类必须配置有效的_GET_URL")
        response = requests.get(cls._GET_URL)
        # 根据实际业务逻辑处理响应并返回子类实例
        return cls()

class Child(Parent):
    _GET_URL = "https://some-url-to-child.me"

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