Python中参数默认值非None时是否应使用Typing.Optional标注？

这类默认值为非None常量的可选参数，类型仅需标注为str，不能标注为Optional[str]。

概念区分 #

很多人会混淆两个完全独立的参数属性：

• 「可选参数（调用时可省略不传）」：仅代表函数为该参数设置了默认值，调用方不传时自动使用默认值，不代表入参允许传入None
• Optional[str]的本质是Union[str, None]，语义是调用时既可以传str，也可以传None，和参数是否可以省略、有没有默认值没有直接关系

错误标注的隐患 #

如果错误把b标注为Optional[str]，相当于向调用方传递了“可以给b传None”的错误约定，一旦调用方真的传入None，而函数内部按字符串逻辑处理b（比如执行b.upper()、字符串拼接），就会直接触发运行时类型错误。

为什么Mypy没有检测出问题 #

Mypy对两种标注都不报错，是符合它的校验逻辑的：

• 标注str时，默认值'hello'完全符合str类型要求，没有矛盾
• 标注Optional[str]时，由于Optional[str]包含str类型，默认值'hello'也属于合法的入参范围，Mypy不会在函数定义层面拦截这种“标注范围比实际允许范围更大”的写法，但这种写法属于语义误导，会让调用方误以为可以传None。

正确写法示例 #

• 旧的注释式类型标注：

def my_func(a, b='hello'):
  # type: (str, str) -> str
  # do stuff with the strings

• Python 3.x原生内联标注：

def my_func(a: str, b: str = "hello") -> str:
    # do stuff with the strings

什么时候才需要用Optional #

只有当参数允许传入None作为合法值时，才需要标注为Optional[类型]，最常见的场景就是参数默认值为None，且函数内部需要对None做特殊处理：

def my_func(a, b=None):
  # type: (str, Optional[str]) -> str
  b = b or "default" # 内部先处理None的情况
  # do stuff with the strings

内容的提问来源于stack exchange，提问作者fooiey