PAYATHON 2026

Pyright 为何拒绝 Protocol 方法使用 pass 函数体?

数据小陈

结论:Pyright/Pylance 不会把 pass 当作 Protocol 方法的“空声明”。它会按普通函数检查返回类型:方法声明了 -> str,但函数体只有 pass,会隐式返回 None,所以报错。把方法体改成 ...,就表示这里只有签名、没有实现。

原因

... 是 Ellipsis 表达式,类型检查器在 Protocol 或存根中通常把它当作占位符;pass 是空语句,函数仍会被推断为隐式返回 None。返回类型不是 None 时,这两种写法的语义并不相同。

解决步骤

  1. 用省略号声明协议方法:
from typing import Optional, Protocol

class Talkable(Protocol):
    def talk(self, topic: Optional[str] = None) -> str: ...
  1. 如果希望运行时调用立即报错,可以写 raise NotImplementedError:
from typing import Optional, Protocol

class Talkable(Protocol):
    def talk(self, topic: Optional[str] = None) -> str:
        raise NotImplementedError
  1. 如果 Protocol 方法需要默认实现,就必须写真实实现,并确保所有返回路径都返回 str;不能只写 pass。

其他类型检查器

常见类型检查器遇到“声明返回 str,但函数体只有 pass”时,通常会报缺少返回值;具体提示和配置可能不同。若返回类型写成 None,pass 可能不会触发返回类型错误,但协议方法仍推荐用 ... 声明。不要依赖某个检查器对 pass 的特殊宽容。

注意事项

  • ... 和 pass 不是等价写法,尤其在返回类型不是 None 时。
  • 协议声明首选 ...;只有明确需要默认实现时,才写真实函数体。
  • 如果方法有默认实现,所有返回路径都必须满足注解。

备注:内容仅供参考。