如何在python中为对象属性（属性）的存在编写接口（合同）？

Question

我想对某个函数的参数进行约定，以强制参数对象必须具有特定属性。我知道 python 不是一种严格类型的语言，但有时拥有合同和接口非常有用。 Python 现在有类型提示，这很棒，所以我们可以这样做：

def myfunc(myparam: MyType) -> SomeType:
    myparam.myprop # this should exist

但是我怎么能说 MyType 必须有一个特定的对象属性（myprop）而不在运行时插入断言和抛出异常呢？ 我可以用 abc 元类定义抽象类，它可以用作接口。

from abc import ABC, abstractmethod
class MyInterface(ABC):
     @property
     @abstractmethod
     def myprop(self) -> int: pass

现在我可以在代码中的某个地方将 MyType 定义为：

class MyType(MyInterface):
    myprop = 8

它正在工作，但是 myprop 是一个类属性，而不是一个对象属性（属性）。我当然可以这样做：

class MyType(MyInterface):
    myprop = 0
    def __init__(self):
        self.myprop = 8

很好，但是我必须定义一个（不必要的）类（“静态”）属性，并使用对象属性有效地隐藏它。不是很干净。此外，现在我有一个 myprop 的默认值，这不是我想要的。但如果我这样做：

class MyType(MyInterface):
    myprop = None  # wrong type here
    def __init__(self):
        self.myprop = 8

这是错误的，因为 myprop 必须是 int 并且不能是 None，这会被 linter 正确捕获。应该有一个没有类属性的对象属性。

目标是像 mypy 这样的静态检查器可以捕获实现错误，其中类不遵守定义的接口或要求参数实例必须具有某些属性的协定。

实现这一点的 Pythonic（或不是 Pythonic）方法是什么？

Answer 1

您无需创建新接口或实现ABC。您可以使用@dataclass。我在 pycharm 中使用默认代码检查器（警告在 cmets 中）。

from dataclasses import dataclass


@dataclass
class MyType:
    my_prop: int


@dataclass
class SomeType:
    my_prop_out: int


def my_func_ok(my_param: MyType) -> SomeType:
    some_type = SomeType(my_prop_out=my_param.my_prop)
    return some_type


def my_func_bad(my_param: MyType) -> SomeType:
    return my_param              # this is not returning SomeType


my_type = MyType()               # this is expecting to set my_prop
my_type = MyType(my_prop="sss")  # this is expecting to set my_prop with int not str
my_func_ok(my_param=100)         # this is expecting MyType object

my_func_ok(my_param=MyType(my_prop=10))  # this is correct, no errors

我正在添加 pycharm 代码检查器警告的图片：

---