Ellipsis 对象有什么作用？

这在最近的另一个 question 中出现。我将从那里详细说明我的 answer：

Ellipsis 是一个可以以切片表示法出现的对象。例如：

myList[1:2, ..., 0]

它的解释完全取决于实现 __getitem__ 函数并在那里看到 Ellipsis 对象的任何东西，但它的主要（和预期）用途是在 numpy 第三方库中，它添加了一个多维数组类型。由于有多个维度，切片变得比仅仅一个开始和停止索引更复杂；能够在多个维度上切片也很有用。例如，给定一个 4 × 4 数组，左上角区域将由切片 [:2, :2] 定义：

>>> a
array([[ 1,  2,  3,  4],
       [ 5,  6,  7,  8],
       [ 9, 10, 11, 12],
       [13, 14, 15, 16]])

>>> a[:2, :2]  # top left
array([[1, 2],
       [5, 6]])

进一步扩展这一点，省略号在这里用于指示未指定的其余数组维度的占位符。将其视为在其放置的间隙中指示所有维度的完整切片 [:]，因此对于 3d 数组，a[..., 0] 与 a[:, :, 0] 相同，对于 4d a[:, :, :, 0]，类似地，a[0, ..., 0]是 a[0, :, :, 0]（中间有许多冒号构成了数组中的全部维数）。

有趣的是，在 python3 中，省略号文字 (...) 可以在切片语法之外使用，因此您实际上可以编写：

>>> ...
Ellipsis

编辑：省略号也用于标准库 typing 模块：例如 Callable[..., int] 表示返回 int 而不指定签名的可调用对象，或 tuple[str, ...] 表示字符串的可变长度同质元组。

---

在 Python 3 中，您可以¹使用省略号文字 ... 作为尚未编写的代码的“nop”占位符：

def will_do_something():
    ...

这不是魔法；可以使用任何表达式代替 ...，例如：

def will_do_something():
    1

（不能使用“sanctioned”这个词，但我可以说这个用法是 Guido 的not outrightly rejected。）

¹ 'can' not in {'must', 'should'}

---

从 Python 3.5 和 PEP484 开始，文字省略号用于在使用 typing 模块时向静态类型检查器表示某些类型。

示例 1：

可以使用一种类型和省略号来表示任意长度的同质元组，例如 Tuple[int, ...]

示例 2：

通过用文字省略号（三个点）代替参数列表，可以在不指定调用签名的情况下声明可调用的返回类型：

def partial(func: Callable[..., str], *args) -> Callable[..., str]:
    # Body

---

总结其他人所说的，从 Python 3 开始，Ellipsis 本质上是另一个类似于 None 的单例常量，但没有特定的预期用途。现有用途包括：

在切片语法中表示剩余维度中的完整切片

在类型提示中仅指示类型的一部分（Callable[..., int] 或 Tuple[str, ...]）

在类型存根文件中表示有一个默认值而不指定它

可能的用途可能包括：

作为 None 是有效选项的地方的默认值

作为您尚未实现的功能的内容

---

您还可以在指定预期的 doctest 输出时使用省略号：

class MyClass(object):
    """Example of a doctest Ellipsis

    >>> thing = MyClass()
    >>> # Match <class '__main__.MyClass'> and <class '%(module).MyClass'>
    >>> type(thing)           # doctest:+ELLIPSIS
    <class '....MyClass'>
    """
    pass

---

从 Python documentation：

此对象通常由切片使用（请参阅切片）。它不支持特殊操作。只有一个省略号对象，名为 Ellipsis（内置名称）。 type(Ellipsis)() 生成 Ellipsis 单例。它被写为省略号或....

---

__getitem__ 自定义类中的最小 ... 示例

在自定义类中将魔术语法 ... 传递给 [] 时，__getitem__() 会收到一个 Ellipsis 类对象。

然后该类可以对这个 Singleton 对象做任何它想做的事情。

例子：

class C(object):
    def __getitem__(self, k):
        return k

# Single argument is passed directly.
assert C()[0] == 0

# Multiple indices generate a tuple.
assert C()[0, 1] == (0, 1)

# Slice notation generates a slice object.
assert C()[1:2:3] == slice(1, 2, 3)

# Ellipsis notation generates the Ellipsis class object.
# Ellipsis is a singleton, so we can compare with `is`.
assert C()[...] is Ellipsis

# Everything mixed up.
assert C()[1, 2:3:4, ..., 6] == (1, slice(2,3,4), Ellipsis, 6)

Python 内置的 list 类选择赋予它范围的语义，当然，任何合理的用法也应该如此。

就个人而言，我只是在我的 API 中远离它，而是创建一个单独的、更明确的方法。

在 Python 3.5.2 和 2.7.12 中测试。

---

对于在大量使用 Pydantic 的代码库中工作而获得此答案的任何人：这也是 Pydantic 指示一个必需但可以设置为 None 的字段的方式，他们将其称为“required optional fields”。这也是为什么它们最终也被用于 FastAPI 的原因。

---

您可以自己使用 Ellipsis，在像 numpy 这样的自定义切片情况下，但它在任何内置类中都没有使用。

我不知道它是否是专门为在 numpy 中使用而添加的，但我当然没有看到它在其他地方使用过。

另请参阅：How do you use the ellipsis slicing syntax in Python?

---

正如@noɥʇʎԀʎzɐɹƆ 和 @phoenix 所提到的 - 您确实可以在存根文件中使用它。例如

class Foo:
    bar: Any = ...
    def __init__(self, name: str=...) -> None: ...

可以在此处找到有关如何使用此省略号的更多信息和示例https://www.python.org/dev/peps/pep-0484/#stub-files

---

它的预期用途不应仅用于这些第 3 方模块。 Python 文档中没有正确提及它（或者我可能只是找不到），但 省略号 ... 实际上在 CPython 中至少在一个地方使用过。

它用于表示 Python 中的无限数据结构。我在玩列表时遇到了这个符号。

有关详细信息，请参阅 this question。

---

这是等价的。

l=[..., 1,2,3]
l=[Ellipsis, 1,2,3]

... 是在 built-in constants 中定义的常量。

省略号 与省略号文字“...”相同。特殊值主要与用户定义的容器数据类型的扩展切片语法结合使用。

---

在 typer 中，... 用于创建必需的参数：Argument 类需要一个默认值，如果您传递 ...，如果用户未传递特定参数，它会报错。

如果 Ellipsis 不存在，您可以使用 None，但这将失去表达 None 是默认值的机会，以防在您的程序中有任何意义.

---

FastAPI 使用省略号来创建所需的参数。 https://fastapi.tiangolo.com/tutorial/query-params-str-validations/

---