Was macht das Ellipsis-Objekt?

Während ich untätig im Namespace surfte, bemerkte ich ein seltsam aussehendes Objekt namens Ellipsis, es scheint nichts Besonderes zu sein oder zu tun, aber es ist ein global verfügbares integriertes Objekt.

Nach einer Suche fand ich heraus, dass es in einer obskuren Variante der Slicing-Syntax von Numpy und Scipy verwendet wird ... aber fast nichts anderes.

Wurde dieses Objekt speziell zur Unterstützung von Numpy + Scipy zur Sprache hinzugefügt? Hat Ellipse überhaupt eine generische Bedeutung oder Verwendung?

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

Dies kam kürzlich in einer anderen Frage auf . Ich werde von dort aus auf meine Antwort eingehen:

Ellipse ist ein Objekt, das in Slice-Notation angezeigt werden kann. Zum Beispiel:

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

Seine Interpretation hängt ausschließlich von dem ab, was die __getitem__Funktion implementiert und EllipsisObjekte dort sieht , aber seine Hauptverwendung (und beabsichtigte Verwendung) liegt in der numpy -Bibliothek eines Drittanbieters, die einen mehrdimensionalen Array-Typ hinzufügt. Da es mehr als eine Dimension gibt, wird das Schneiden komplexer als nur ein Start- und Stoppindex. Es ist nützlich, auch in mehreren Dimensionen schneiden zu können. Bei einem 4x4-Array würde der obere linke Bereich beispielsweise durch das Slice definiert [: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]])

In diesem Zusammenhang wird Ellipse hier verwendet, um einen Platzhalter für die übrigen nicht angegebenen Array-Dimensionen anzugeben. Denken Sie daran , als Hinweis auf die volle Scheibe [:]für alle Dimensionen in dem Spalte sie platziert wird, so dass für ein 3D - Array, a[...,0]ist das gleiche wie a[:,:,0]und 4d a[:,:,:,0], in ähnlicher Weise, a[0,...,0]ist a[0,:,:,0](mit jedoch vielen Doppelpunkten in der Mitte bildet die volle Zahl von Dimensionen im Array).

Interessanterweise kann in python3 das Ellipsis-Literal ( ...) außerhalb der Slice-Syntax verwendet werden, sodass Sie tatsächlich schreiben können:

>>> ...
Ellipsis

Abgesehen von den verschiedenen numerischen Typen, nein, ich glaube nicht, dass es verwendet wird. Soweit mir bekannt ist, wurde es nur für den Numpy-Gebrauch hinzugefügt und hat keine andere Kernunterstützung als die Bereitstellung des Objekts und der entsprechenden Syntax. Das Objekt, das dort war, erforderte dies nicht, aber die wörtliche "..." Unterstützung für Slices tat dies.

In Python 3 können Sie das Ellipsen-Literal ...als Platzhalter für Code verwenden:

def will_do_something():
    ...

Das ist keine Magie; Jeder Ausdruck kann verwendet werden anstelle von ...z.

def will_do_something():
    1

(Ich kann das Wort "sanktioniert" nicht verwenden, aber ich kann sagen, dass diese Verwendung von Guido nicht direkt abgelehnt wurde.)

Ab Python 3.5 und PEP484 wird die wörtliche Ellipse verwendet, um bestimmte Typen einer statischen Typprüfung zu kennzeichnen, wenn das Typisierungsmodul verwendet wird.

Beispiel 1:

Homogene Tupel beliebiger Länge können beispielsweise mit einem Typ und einer Ellipse ausgedrückt werden Tuple[int, ...]

Beispiel 2:

Es ist möglich, den Rückgabetyp eines aufrufbaren Objekts ohne Angabe der Aufrufsignatur zu deklarieren, indem die Liste der Argumente durch ein wörtliches Auslassungszeichen (drei Punkte) ersetzt wird:

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

Sie können auch die Ellipse verwenden, wenn Sie die erwartete Doctest- Ausgabe angeben :

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

Aus der Python-Dokumentation :

Dieses Objekt wird üblicherweise beim Schneiden verwendet (siehe Slicings ). Es werden keine speziellen Operationen unterstützt. Es gibt genau ein Ellipsenobjekt namens Ellipse (ein eingebauter Name). type(Ellipsis)()produziert den Ellipsis-Singleton.

Es ist geschrieben als Ellipsisoder ....

Zusammenfassend ist Ellipsis ab Python 3 eine weitere Singleton-Konstante, die der Singleton-Konstante ähnelt None, jedoch ohne eine bestimmte beabsichtigte Verwendung ist. Bestehende Verwendungen umfassen:

• In der Slice-Syntax, um das gesamte Slice in den verbleibenden Dimensionen darzustellen
• In Typhinweisen, die nur einen Teil eines Typs angeben ( Callable[..., int]oder Tuple[str, ...])
• Geben Sie in Typ-Stub-Dateien einen Standardwert an, ohne ihn anzugeben

Mögliche Verwendungen könnten sein:

• Als Standardwert für Orte, an denen Noneeine gültige Option ist
• Als Inhalt für eine Funktion haben Sie noch nicht implementiert

__getitem__minimales ...Beispiel in einer benutzerdefinierten Klasse

Wenn die Magie Syntax ...zu übergeben wird []in einer benutzerdefinierten Klasse, __getitem__()erhält ein EllipsisKlassenobjekt.

Die Klasse kann dann mit diesem Singleton-Objekt tun, was sie will.

Beispiel:

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)

Die in Python integrierte listKlasse gibt ihr die Semantik eines Bereichs, und jede vernünftige Verwendung sollte dies natürlich auch tun.

Persönlich würde ich mich in meinen APIs einfach davon fernhalten und stattdessen eine separate, explizitere Methode erstellen.

Getestet in Python 3.5.2 und 2.7.12.

Sie können Ellipsis selbst verwenden, in benutzerdefinierten Slicing-Situationen, wie es Numpy getan hat, aber es wird in keiner integrierten Klasse verwendet.

Ich weiß nicht, ob es speziell für die Verwendung in Numpy hinzugefügt wurde, aber ich habe es sicherlich nicht anderswo gesehen.

Siehe auch: Wie verwenden Sie die Syntax zum Schneiden von Auslassungspunkten in Python?

Wie von @ noɥʇʎԀʎzɐɹƆ und @phoenix erwähnt - Sie können es tatsächlich in Stub-Dateien verwenden. z.B

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

Weitere Informationen und Beispiele zur Verwendung dieser Auslassungspunkte finden Sie hier https://www.python.org/dev/peps/pep-0484/#stub-files

Die beabsichtigte Verwendung sollte nicht nur für diese Module von Drittanbietern sein. Es wird in der Python-Dokumentation nicht richtig erwähnt (oder vielleicht konnte ich das einfach nicht finden), aber die Auslassungspunkte ...werden in CPython tatsächlich an mindestens einer Stelle verwendet.

Es wird zur Darstellung unendlicher Datenstrukturen in Python verwendet. Ich bin auf diese Notation gestoßen, als ich mit Listen herumgespielt habe.

Weitere Informationen finden Sie in dieser Frage .

Das ist gleichwertig.

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

...ist eine im Inneren definierte Konstante built-in constants.

Ellipse

Das gleiche wie das Auslassungsliteral "...". Spezieller Wert, der hauptsächlich in Verbindung mit der erweiterten Slicing-Syntax für benutzerdefinierte Container-Datentypen verwendet wird.