¿Qué hace el objeto Python Ellipsis?

Question

Mientras navegaba ociosamente en el espacio de nombres noté un objeto de aspecto extraño llamado "Ellipsis", no parece ser ni hace nada especial, pero es una construcción interna disponible en todo el mundo.

Después de una búsqueda encontré que se usa en algunas variantes oscuras de la sintaxis de corte por Numpy y Scipy ... pero casi nada más.

¿Se ha agregado este objeto al idioma específicamente para admitir Numpy + Scipy? Ellipsis tiene algún significado genérico o uso en absoluto?

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 

Answer 1

Esto apareció en otro question recientemente. Elaboraré en mi answer desde allí:

Ellipsis es un objeto que puede aparecer en la notación de división. Por ejemplo:

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

Su interpretación es puramente hasta lo implementa la función __getitem__ y ve Ellipsis objetos allí, pero su principal (y la intención) es el uso de la extensión numeric python, lo que añade un tipo de matriz multidimensional. Como hay más de una dimensión, cortar se vuelve más complejo que solo un índice de inicio y finalización; también es útil para cortar en varias dimensiones. Por ejemplo, dada una matriz de 4x4, la zona superior izquierda se definiría por la rebanada [: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]]) 

La extensión de este más allá, Ellipsis se utiliza aquí para indicar un marcador de posición para el resto de las dimensiones de la matriz no especificados. Piense en ello como indicando el corte completo [:] para todas las dimensiones en el espacio en el que está colocado, por lo que para un arreglo 3D, a[...,0] es lo mismo que a[:,:,0] y para 4d, a[:,:,:,0], del mismo modo, a[0,...,0] es a[0,:,:,0] (con tantos puntos en el el medio compone el número completo de dimensiones en la matriz).

Curiosamente, en python3, los puntos suspensivos literal (...) se puede utilizar fuera de la sintaxis de corte, por lo que en realidad se puede escribir:

>>> ... 
Ellipsis 

Aparte de los diversos tipos numéricos, no, no creo que es usado.Por lo que yo sé, fue agregado exclusivamente para uso numpy y no tiene ningún soporte básico que no sea proporcionar el objeto y la sintaxis correspondiente. El objeto que estaba allí no lo requería, pero el soporte literal "..." sí lo requería.

Answer 2

Puede utilizar puntos suspensivos a sí mismo, en situaciones de rebanado personalizados como numpy ha hecho, pero no tiene ningún uso en cualquier clase incorporado.

No sé si se ha agregado específicamente para su uso en numpy, pero ciertamente no lo he visto en otro lugar.

Consulte también: How do you use the ellipsis slicing syntax in Python?

Answer 3

Desde el Python documentation:

Este objeto se utiliza la notación extendida por rebanada (ver la Python Reference Manual). No admite operaciones especiales . Hay exactamente un objeto ellipsis , llamado Ellipsis (un nombre incorporado ).

Answer 4

En Python 3, puede utilizar los puntos suspensivos literal ... como un marcador de posición “nop” para el código:

def will_do_something(): 
    ... 

Ésta es no magia; cualquier expresión se puede utilizar en lugar de ..., por ejemplo:

def will_do_something(): 
    1 

(. No se puede utilizar la palabra “sancionado”, pero puedo decir que este uso fue not outrightly rejected por Guido)

Answer 5

También puede utilizar los puntos suspensivos al especificar espera doctest de salida:

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 

Answer 6

Su uso pretendido no debe ser sólo para estos módulos de 3 ª parte. No se menciona correctamente en la documentación de Python (o tal vez no pude encontrarlo) pero el elipse ... se usa realmente en CPython en al menos un lugar.

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

Consulte this question para obtener más información.

Answer 7

__getitem__ ejemplos mínimos

sirve como valor de la magia clase singleton que se pasa a __getitem__ cuando se utiliza la sintaxis ... "magia de aspecto".

La clase puede hacer lo que quiera con ella.

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 an Ellipsis class object. 
assert C()[...] == Ellipsis 

El Python incorporado list clase elige para darle la semántica de un intervalo, y cualquier uso cuerdo de lo que debería también, por supuesto.

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

Answer 8

A partir de Python 3.5 y PEP484, la elipsis literal se utiliza para denotar ciertos tipos a un verificador de tipo estático cuando se utiliza el módulo typing.

Ejemplo 1:

-longitud arbitraria tuplas homogéneos pueden ser expresados ​​usando un tipo y puntos suspensivos, por ejemplo Tuple[int, ...]

Ejemplo 2:

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

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

Answer 9

como se ha mencionado por @ noɥʇʎԀʎzɐɹƆ y @phoenix - Efectivamente, puedes utilizarlo en archivos de marcadores. p.ej.

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

Más información y ejemplos de cómo utilizar esta elipse se pueden descubrir aquí https://www.python.org/dev/peps/pep-0484/#stub-files