python3中三个点是啥意思?

阿常呓语

已于 2022-08-31 20:37:43 修改

阅读量5.9k

点赞数 8

分类专栏： python基础&进阶文章标签： python type hint

于 2022-08-08 23:03:00 首次发布

本文链接：https://blog.csdn.net/u010339879/article/details/126238080

版权

python基础&进阶专栏收录该内容

63 篇文章 21 订阅

订阅专栏

python3中三个点是啥意思?

问题引入

前段时间看 fastapi 代码的时候，看类型注解的部分经常出现 ... 这样的东西，我就不理解这是什么意思呢？

比如像下面这个参数的类型注解，Callable 这个类型，我们知道代表可调用类型，这里里面有三个点是什么意思呢？

call: Optional[Callable[..., Any]]

来看一下 callalbe 注解如何使用

from typing import Callable


def add(a: int, b: int) -> int:
    pass
    return a + b


def main(fn: Callable[[int, int], int], a: int, b: int):
    return fn(a, b)


if __name__ == '__main__':
    print(main(add, 10, 2))

Callable[[int, int], int] 这里我定义了一个注解，这个注解的意思，就是这是个可调用的对象，接受两个int 类型的参数，返回一个int的值。

这里我定义一个其他的类型，传入到main 函数中就会发现会给出一个警告。

在这里插入图片描述

Callable 这个对象如果接受两个值，第一个值为一个list，list存放参数的类型，第二值存放可调用对象的返回值returnType

Calllabe[[a,b,c...],ReturnType] 类似于这种结构，返回类型只能是单一类型。

第一种用法

Callable[..., ReturnType] （省略号字面量）可用于为接受任意数量参数，并返回 ReturnType 的可调对象提供类型提示。

如果是这样子的形式，表示参数类型，以及数量不做限制，返回类型为 Returntype 类型。

所以说纯 Callable 等价于 Callable[..., Any]

看下面的代码，也就明白了，这里endpoint 就是一个可调用对象即可，返回类型也是任意的。

def add_api_websocket_route(
  self, path: str, endpoint: Callable[..., Any], name: Optional[str] = None
) -> None:
  	pass

第二种用法三个点的含义

有的时候 ellipsis 省略号出现在函数的定义的后面，此时这个时候就是占位符的意思，相当于 pass 的感觉，本身并没有什么实际含义，只是表明这是一个代码块。如果没有pass 或者 ... 会报语法的错误。

看下面的例子就是这样子

def caculate(age: int) -> int: ...

def caculate(age: int) -> int:
    ...

第三种用法必选项

在pydantic 这个库中，对于字段验证的时候，也可以传入 ... 来表示这个字段是必选的。

来看下一个例子

from pydantic import BaseModel, Field


class Item(BaseModel):
    # ... 这里表示必须的意思
    name: str = Field(...)
    price: float = Field(default=10)

      
if __name__ == '__main__':
    item = Item(name='book', price=13.8)
    item2 = Item(price=13.8)
    print(item2)

item2 会报错，因为没有传入name 的值，这个值不能为空，为必选项。

报错如下：

Traceback (most recent call last):
  File "/Users/frank/code/py_proj/study-fastapi/helloworld/mymodel.py", line 21, in <module>
    item2 = Item(price=13.8)
  File "pydantic/main.py", line 341, in pydantic.main.BaseModel.__init__
pydantic.error_wrappers.ValidationError: 1 validation error for Item
name
  field required (type=value_error.missing)

顺便提一下，如果想让这个字段是可选的，添加 Optional 这个类型就可以了.

from typing import Optional

from pydantic import BaseModel, Field


class Item(BaseModel):
    # 可选的字段值，字段值默认为None 
    name: Optional[str] = Field(default=None)
    price: float = Field(default=10)


if __name__ == '__main__':
    item2 = Item(price=13.8)
    print(item2) # name=None price=13.8