如何键入可变的默认参数

Question

在 Python 中处理可变默认参数的方法是 set them to None。

例如：

def foo(bar=None):
    bar = [] if bar is None else bar
    return sorted(bar)

如果我输入函数定义，那么 bar 的唯一类型是 bar，而当我希望运行 sorted 函数时，显然它不是 Optional就可以了：

def foo(bar: Optional[List[int]]=None):
    bar = [] if bar is None else bar
    return sorted(bar) # bar cannot be `None` here

那我应该投吗？

def foo(bar: Optional[List[int]]=None):
    bar = [] if bar is None else bar
    bar = cast(List[int], bar) # make it explicit that `bar` cannot be `None`
    return sorted(bar)

我是否应该只希望通读函数的人看到处理默认可变参数的标准模式并理解对于函数的其余部分，参数不应该是Optional？

处理此问题的最佳方法是什么？

编辑： 澄清一下，这个函数的用户应该能够调用foo作为foo()和foo(None)和foo(bar=None)。 （我认为任何其他方式都没有意义。）

编辑#2： 如果您从不将bar 输入为Optional 而是仅将其输入为List[int]，Mypy 将run with no errors，尽管默认值为None。但是，强烈不建议这样做，因为这种行为将来可能会改变，而且它还隐式将参数键入为Optional。 （详见this。）

Answer 1

None 不是唯一可用的哨兵。您可以选择您的自己的列表值作为哨兵，在运行时用新的空列表替换它（而不是None）。

_sentinel = []

def foo(bar: List[int]=_sentinel):
    bar = [] if bar is _sentinel else bar
    return sorted(bar)

只要没有人使用_sentinel 作为显式参数调用foo，bar 总是会得到一个新的空列表。在像foo([]) 这样的调用中，bar is _sentinel 将是错误的：两个空列表不是同一个对象，因为列表的可变性意味着您不能拥有一个始终被 [] 引用的空列表。

Answer 2

当你影子bar时，为什么不直接删掉演员：

def foo(bar: Optional[List[int]]=None):
    bar : List[int] = [] if bar is None else bar
    return sorted(bar)

Answer 3

我不确定这里有什么问题，因为在 mypy 中使用 Optional[List[int]] 作为类型非常好：https://mypy-play.net/?mypy=latest&python=3.9&gist=2ee728ee903cbd0adea144ce66efe3ab

在你的情况下，当 mypy 看到 bar = [] if bar is None else bar 时，它足够聪明地意识到 bar 不能是 None 超出这一点，从而将类型缩小到 List[int]。在此处阅读有关 mypy 中类型缩小的更多信息：https://mypy.readthedocs.io/en/stable/kinds_of_types.html?highlight=narrow#union-types

这里是缩小类型的some other examples：

from typing import *

a: Optional[int]
assert a is not None
reveal_type(a)  # builtins.int

b: Union[int, float, str]
if isinstance(b, int):
    reveal_type(b)  # builtins.int
else:
    reveal_type(b)  # Union[builtins.float, builtins.str]

Answer 4

如果您在函数中为参数添加默认值而不是“是”，则它是可选的。 同样在您的代码中，您允许调用者不向函数提供任何内容，它仍然有效，因为它只是创建一个空列表。

在 python 中，即使键入它也不强制类型。这就是为什么它在文档中被称为“类型提示”。

因此，如果您想允许调用者不带参数地调用该函数，并且它只是对一个空列表进行排序，那么您的代码是正确的。

def foo(bar=None):
    bar = [] if bar is None else bar
    return sorted(bar)

但是，如果您不希望调用者不提供任何内容，甚至是 None，那么您应该更改您的函数签名。

def foo(bar: List[int]):
    bar = [] if bar is None else bar
    return sorted(bar)

现在类型提示检测到bar 是List[int]。你必须将一些东西传递给foo。所以你可以做foo(None)这就是为什么你需要None检查但现在foo()是无效的并抛出一个错误。

如果您确实希望他们不传递任何内容，那么只需执行此操作，输入提示仍然有效。

def foo(bar: List[int]=None):
   bar = [] if bar is None else bar
   return sorted(bar)

Answer 5

使用Sequence[int]怎么样？将检查参数（包括其默认值）几乎是只读。

from collections.abc import Sequence

def foo(bar: Sequence[int] = []) -> list[int]:
    return sorted(bar)

bar 仍然可以如下变异，但风险不会很高。 （_sentinel: list[int] = [] 也可以变异。）

def foo(bar: Sequence[int] = []) -> list[int]:
    if isinstance(bar, list):
        # reveal_type(bar)  # => Revealed type is "builtins.list[Any]"
        bar.append(0)
    return sorted(bar)