在空闲地浏览名称空间时,我注意到一个名为Ellipsis的奇怪对象,它看起来没有什么特别之处,也没有做什么特别的事情,但它是一个全局可用的内置对象。

经过搜索,我发现Numpy和Scipy在切片语法的一些模糊变体中使用了它。。。但几乎没有其他。

该对象是否专门添加到语言中以支持Numpy+Scipy?Ellipsis有任何通用的含义或用途吗?

D:\workspace\numpy>python
Python 2.4.4 (#71, Oct 18 2006, 08:34:43) [MSC v.1310 32 bit (Intel)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> Ellipsis
Ellipsis

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

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

另请参阅:如何在Python中使用省略号切片语法?


从Python文档中:

此对象通常用于切片(请参见切片)。它不支持特别行动。只有一个省略号对象,名为椭圆(内置名称)。类型(椭圆)()生成椭圆单例。它被写成椭圆或。。。。


这在最近的另一个问题中出现。我将从那里详细阐述我的答案:

椭圆是一种可以以切片表示法显示的对象。例如:

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数组,[…,0]与[:,:,0]相同,对于4d,a[:,,:,:。

有趣的是,在python3中,省略文本(…)在切片语法之外是可用的,因此您实际上可以编写:

>>> ...
Ellipsis

EDIT:Ellipsis也用于标准库类型模块:例如Callable[…,int]表示返回int而不指定签名的可调用对象,或tuple[str,…]表示字符串的可变长度同质元组。


在Python 3中,您可以¹使用Ellipsis文字。。。作为尚未编写的代码的“nop”占位符:

def will_do_something():
    ...

这不是魔法;可以使用任何表达式来代替。。。,例如。:

def will_do_something():
    1

(不能使用“受制裁”一词,但我可以说,圭多并没有断然拒绝使用这个词。)

¹“can”不在{“must”,“should”}中


在指定预期的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文档中没有正确提到它(或者我可能找不到),但省略号。。。实际上在CPython中至少有一个地方使用。

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

有关详细信息,请参阅此问题。


__getitem_最小。。。自定义类中的示例

当神奇的语法。。。在自定义类中传递给[],__getitem__()接收Ellipse类对象。

然后,类可以对这个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内置列表类选择为其提供范围的语义,当然,任何合理的用法都应该如此。

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

在Python 3.5.2和2.7.12中测试。


与Python3.5和PEP484一样,在使用类型模块时,文本省略号用于向静态类型检查器表示某些类型。

示例1:

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

示例2:

通过用文字省略号(三个点)替换参数列表,可以在不指定调用签名的情况下声明可调用的返回类型:

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

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

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

有关如何使用此省略号的更多信息和示例,请参见此处https://www.python.org/dev/peps/pep-0484/#stub-文件


总结其他人所说的,与Python 3一样,Ellipsis本质上是另一个类似于None的单例常量,但没有特定的用途。现有用途包括:

在切片语法中表示剩余维度中的完整切片在类型提示中,仅指示类型的一部分(Callable[…,int]或Tuple[str,…])在类型存根文件中,指示有一个默认值,而不指定它

可能的用途包括:

作为“无”是有效选项的地方的默认值作为尚未实现的函数的内容


这是等效的。

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

…是在内置常量中定义的常量。

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


在打字机中。。。用于创建必需的参数:Argument类需要默认值,如果传递。。。如果用户没有传递特定的参数,它将发出抱怨。

如果Ellipsis不在,您可以使用None,但这将消除表示None是默认值的机会,以防在程序中有任何意义。


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


对于在Pydantic使用量很大的代码库中工作而得出这个答案的人来说:这也是Pydantic表示需要但可以设置为None的字段的方式,他们称之为“必需的可选字段”。这就是为什么它们最终也被用于FastAPI的原因。