¿Qué hace el objeto de puntos suspensivos?

Mientras navegaba distraídamente por el espacio de nombres, noté que se llamaba un objeto de aspecto extraño Ellipsis, que no parece ser o no hace nada especial, pero es un componente incorporado disponible a nivel mundial.

Después de una búsqueda descubrí que Numpy y Scipy lo usan en alguna variante oscura de la sintaxis de corte ... pero casi nada más.

¿Se agregó este objeto al lenguaje específicamente para admitir Numpy + Scipy? ¿Ellipsis tiene algún significado genérico o uso?

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

Esto surgió en otra pregunta recientemente. Explicaré mi respuesta a partir de ahí:

Elipsis es un objeto que puede aparecer en notación de corte. Por ejemplo:

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

Su interpretación es puramente hasta cualquier implementa la __getitem__función y ve Ellipsislos objetos allí, pero su principal (y la intención) es el uso en el numpy biblioteca de terceros, lo que añade un tipo de matriz multidimensional. Como hay más de una dimensión, el corte se vuelve más complejo que solo un índice de inicio y detención; También es útil poder cortar en varias dimensiones. Por ejemplo, dada una matriz 4x4, el área superior izquierda estaría definida por el segmento [: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]])

Extendiendo esto más, Elipsis se usa aquí para indicar un marcador de posición para el resto de las dimensiones de la matriz no especificadas. Piense en ello como indicando el corte completo [:]para todas las dimensiones en el espacio en el que se coloca, por lo que para una matriz 3D, a[...,0]es igual a[:,:,0]y para 4d a[:,:,:,0], de manera similar, a[0,...,0]esa[0,:,:,0] (con sin embargo muchos signos de dos puntos en la composición media de hasta el número completo de dimensiones en la matriz).

Curiosamente, en python3, el Elipsis literal ( ...) se puede usar fuera de la sintaxis de corte, por lo que puede escribir:

>>> ...
Ellipsis

Aparte de los diversos tipos numéricos, no, no creo que se use. Hasta donde yo sé, se agregó únicamente para un uso complejo y no tiene soporte principal aparte de proporcionar el objeto y la sintaxis correspondiente. El objeto que estaba allí no requería esto, pero el soporte literal "..." para los cortes sí.

En Python 3, puede usar el literal de puntos suspensivos ...como un marcador de posición "nop" para el código:

def will_do_something():
    ...

Esto no es magia; se puede usar cualquier expresión en lugar de ..., por ejemplo:

def will_do_something():
    1

(No puedo usar la palabra "sancionado", pero puedo decir que Guido no rechazó este uso ).

A partir de Python 3.5 y PEP484 , los puntos suspensivos literales se usan para denotar ciertos tipos a un verificador de tipo estático cuando se usa la escritura módulo de .

Ejemplo 1:

Las tuplas homogéneas de longitud arbitraria se pueden expresar usando un tipo y puntos suspensivos, por ejemplo Tuple[int, ...]

Ejemplo 2

Es posible declarar el tipo de retorno de un invocable sin especificar la firma de la llamada sustituyendo una elipsis literal (tres puntos) por la lista de argumentos:

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

También puede usar los puntos suspensivos al especificar la salida doctest esperada :

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

De la documentación de Python :

Este objeto se usa comúnmente para cortar (ver Cortar ). No admite operaciones especiales. Hay exactamente un objeto de puntos suspensivos, denominado Puntos suspensivos (un nombre incorporado). type(Ellipsis)()produce la elipsis singleton.

Está escrito como Ellipsiso ....

Resumiendo lo que otros han dicho, a partir de Python 3, Ellipsis es esencialmente otra constante singleton similar a None, pero sin un uso previsto particular. Los usos existentes incluyen:

• En sintaxis de corte para representar el corte completo en las dimensiones restantes
• En sugerencias de tipo para indicar solo una parte de un tipo ( Callable[..., int]o Tuple[str, ...])
• En tipo stub files para indicar que hay un valor predeterminado sin especificarlo

Los posibles usos podrían incluir:

• Como valor predeterminado para lugares donde Nonees una opción válida
• Como el contenido de una función que aún no ha implementado

__getitem__...ejemplo mínimo en una clase personalizada

Cuando la sintaxis mágica ...se pasa a []una clase personalizada, __getitem__()recibe un Ellipsisobjeto de clase.

La clase puede hacer lo que quiera con este objeto Singleton.

Ejemplo:

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)

El Python incorporado list clase elige darle la semántica de un rango, y cualquier uso sensato de él también debería, por supuesto.

Personalmente, me mantendría alejado de esto en mis API y crearía un método separado y más explícito.

Probado en Python 3.5.2 y 2.7.12.

Puede usar puntos suspensivos usted mismo, en situaciones de corte personalizado como numpy lo ha hecho, pero no tiene uso en ninguna clase integrada.

No sé si se agregó específicamente para usar en numpy, pero ciertamente no lo he visto usado en otro lugar.

Ver también: ¿Cómo se usa la sintaxis de corte de puntos suspensivos en Python?

Como lo mencionaron @ noɥʇʎԀʎzɐɹƆ y @phoenix: de hecho, puede usarlo en archivos stub. p.ej

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

Puede encontrar más información y ejemplos de cómo usar estos puntos suspensivos aquí https://www.python.org/dev/peps/pep-0484/#stub-files

Su uso previsto no debería ser solo para estos módulos de terceros. No se menciona correctamente en la documentación de Python (o tal vez simplemente no pude encontrar eso), pero los puntos suspensivos ...se usan en CPython en al menos un lugar.

Se utiliza para representar estructuras de datos infinitas en Python. Encontré esta notación mientras jugaba con las listas.

Vea esta pregunta para más información.

Esto es equivalente

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

...Es una constante definida en su interior built-in constants.

Elipsis

Lo mismo que la elipsis literal "...". Valor especial utilizado principalmente junto con la sintaxis de segmentación extendida para tipos de datos de contenedor definidos por el usuario.