在 Python 中的“模板方法模式”继承中使用派生类上已实现方法的签名用于从基类继承的方法

Question

假设我们有Template method pattern 继承场景。我正在使用请求库的示例。

import abc
import json
import requests
from typing import Dict, Any

class Base(abc.ABC)
    @abc.abstractmethod
    def call(self, *args, **kwargs) -> requests.Response:
        raise NotImplementedError

    def safe_call(self, *args, **kwargs) -> Dict[str, Any]:
        try:
            response = self.call(*args, **kwargs)
            response.raise_for_status()
            return response.json()
        except json.JSONDecodeError as je: ...
        except requests.exceptions.ConnectionError as ce: ...
        except requests.exceptions.Timeout as te: ...
        except requests.exceptions.HTTPError as he: ...
        except Exception as e: ...
        return {"success": False}


class Derived(Base):
    def call(self, url: str, json: Dict[str, Any], timeout: int, retries: int) -> requests.Response:
        # actual logic for making the http call
        response = requests.post(url, json=json, timeout=timeout, ...)
        return response

将像这样使用

executor = Derived()
response = executor.safe_call(url='https://example.com', json={"key": "value"}, ...)

有没有办法将Derived.call 的签名附加到Derived.safe_call 以便现代IDE 自动完成和类型检查器工作？ 因为这看起来很像装饰器模式，所以我尝试在__init__ 中使用functools.update_wrapper，但失败了

AttributeError: 'method' object has no attribute '__module__'

我确实有一些选择，但我找不到关于这个问题的任何建议

1. 我可以在类完全构建之前通过元类路径来更改签名和文档字符串属性。但是，这可能不适用于 IDE。
2. 我可以定义一个存根文件.pyi 并与主代码一起维护它。

class Derived(Base):
    def safe_call(self, url: str, json: Dict[str, Any], timeout: int, retries: int) -> Dict[str, Any]: ...

1. 彻底改变设计

2. （编辑：添加帖子第一个答案）（Ab）使用@typing.overload

class Derived(Base):
    @typing.overload
    def safe_call(self, url: str, json: Dict[str, Any], timeout: int, retries: int) -> Dict[str, Any]:
        ...

    def call(self, url: str, json: Dict[str, Any], timeout: int, retries: int) -> requests.Response:
        # actual logic for making the http call
        response = requests.post(url, json=json, timeout=timeout, ...)
        return response

Answer 1

我知道你在做什么，但我认为沿着这条路走可能是一个错误，因为它会破坏Liskov Substitution Principle。

目前，您的抽象类 Base 定义了一个接口，在该接口的具体实现中，方法 Base.call 可以使用 任何位置或关键字参数调用，而不会在运行。从理论的角度来看，call 在Derived 类中的具体实现不满足此接口。如果使用>4 个参数调用，使用url、json、timeout 或retries 的关键字参数调用，它将在运行时引发错误。

Python 仍然允许您在运行时实例化Derived 的实例，因为它只检查与Base 中定义的抽象方法同名的方法是否存在。它不会在具体实现的实例化时检查抽象方法的签名兼容性，并且尝试这样做将非常困难。但是，一些类型检查器可能会抱怨派生类中的签名比基类中的签名更宽松。此外，理论原理本身也很重要。

我认为要走的路可能是这样的。注意两点：

1. 基类中的safe_call 和call 方法都已成为私有方法，因为它们是不能直接使用的实现细节。
2. 我在基类中更改了call 和safe_call 的签名，使它们只接受关键字参数。

import abc
import json
import requests
from typing import Dict, Any

class Base(abc.ABC)
    @abc.abstractmethod
    def _call(self, **kwargs: Any) -> requests.Response:
        raise NotImplementedError

    def _safe_call(self, **kwargs: Any) -> Dict[str, Any]:
        try:
            response = self.call(**kwargs)
            response.raise_for_status()
            return response.json()
        except json.JSONDecodeError as je: ...
        except requests.exceptions.ConnectionError as ce: ...
        except requests.exceptions.Timeout as te: ...
        except requests.exceptions.HTTPError as he: ...
        except Exception as e: ...
        return {"success": False}


class Derived(Base):
    def _call(self, **kwargs: Any) -> requests.Response:
        url: str = kwargs['url']
        json: Dict[str, Any] = kwargs['json']
        timeout: int = kwargs['timeout']
        retries: int = kwargs['retries']
        
        # actual logic for making the http call
        response = requests.post(url, json=json, timeout=timeout, ...)
        return response

    def safe_call_specific_to_derived(self, url: str, json: Dict[str, Any], timeout: int, retries: int) -> Dict[str, Any]:
        return self._safe_call(url=url, json=json, timeout=timeout, retries=retries)

如果您想在_call 的具体实现中为参数设置默认值，请注意您可以使用kwargs.get(<arg_name>, <default_val>) 而不是kwargs[<arg_name>]