如何使用静态检查来确保对象具有特定的方法/属性？ [复制]

Question

我有什么方法可以注释函数以确保传递给函数的对象具有特定的方法或属性，但我不关心它的实际类型？

Pycharm 内部使用类似于 {b} 的语法来指示它推断出的对象需要哪些方法/属性，但这似乎不是有效的 Python 语法：

def func(a: {b}):  # Error
    a.b = 1

有没有办法让类型检查器帮助鸭子打字，我只关心对象有哪些方法/属性，而不关心对象的类型是什么，以及我无法修改我想要的类型检查？

Answer 1

Protocols 可以使用。我在这里记录它是因为我发现这是一个很难搜索的主题；尤其是检查属性是否存在。

为了确保属性的存在：

from typing import Protocol

class HasFoo(Protocol):     # Define what's required
    foo: int

class Foo:                  # This class fulfills the protocol implicitly
    def __init__(self):
        self.foo = 1

class Bar:
    def __init__(self):     # This class fails to implicitly fulfill the protocol
        self.bar = 2

def foo_func(f: HasFoo):
    pass

foo_func(Foo())             # Type check succeeds
foo_func(Bar())             # Type check fails

注意foo 后面的类型提示。该行必须在语法上有效，并且类型必须与所检查属性的推断类型相匹配。如果您关心foo 的存在，而不关心它的类型，typing.Any 可以用作占位符。

---

同样，检查方法也可以这样做：

class HasFoo(Protocol):
    def foo(self):
        pass

class Foo:
    def foo(self):
        pass
    
class Bar:
    def bar(self):
        pass

def func(f: HasFoo):
    pass

func(Foo())             # Succeeds
func(Bar())             # Fails

---

类型检查是通过Pycharm 2020.2.2 完成的。