使用标记值作为默认值的类型提示参数

Question

当我无法在函数签名中分配默认参数和/或None 已经有意义时，我目前使用this strategy。

from typing import Optional

DEFAULT = object()


# `None` already has meaning.
def spam(ham: Optional[list[str]] = DEFAULT):
    if ham is DEFAULT:
        ham = ['prosciutto', 'jamon']
    if ham is None:
        print('Eggs?')
    else:
        print(str(len(ham)) + ' ham(s).')

错误：

Failed (exit code: 1) (2607 ms)

main.py:7: error: Incompatible default for argument "ham" (default has type "object", argument has type "Optional[List[str]]")
Found 1 error in 1 file (checked 1 source file)

• 如何在 mypy 中输入提示 ham 而不会出现错误？ 或
• 我应该使用什么策略来代替DEFAULT = object()？

Answer 1

正如我所评论的，这是 Python 中一个活跃的开发领域。 PEP 661 建议添加一个 sentinel 函数来创建一个哨兵对象，但在该 PEP 获得批准之前，您只能靠自己。

不过，您可以从 PEP 中的一些建议（或拒绝）选项中获得灵感。一种非常简单的方法可以很好地与类型提示配合使用，即使您的哨兵值成为一个类：

class DEFAULT: pass

现在您可以将您的函数类型提示为采用包括 type[DEFAULT] 在内的类型的联合：

def spam(ham: list[str]|None|type[DEFAULT] = DEFAULT):

Answer 2

我喜欢做的事情——这只是 @Blckknght's answer 的一个细微变化——是使用一个元类给我的哨兵类一个更好的 repr 并让它永远是假的。

---

sentinel.py

from typing import Literal 

class SentinelMeta(type):
    def __repr__(cls) -> str:
        return f'<{cls.__name__}>'

    def __bool__(cls) -> Literal[False]:
        return False


class Sentinel(metaclass=SentinelMeta): pass

ma​​in.py

from sentinel import Sentinel

class DEFAULT(Sentinel): pass

---

您在类型提示中使用它的方式与@Blckknght 建议的方式完全相同：

def spam(ham: list[str]|None|type[DEFAULT] = DEFAULT): ...

但您还有一个额外的优势，即您的哨兵值总是虚假的并且具有更好的代表：

>>> DEFAULT
<DEFAULT>
>>> bool(DEFAULT)
False