python / python/cpython

`iter()` doesn't require a "collection"

Offen
#155,856 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

docs
Vorherrschende Sprache
Python
Sterne
77.2k
Forks
35.9k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

Documentation

The documentation for iter() says, for the one-argument form:

iter(iterable, /)

Return an iterator object. [...] the single argument must be a collection object which supports the iterable protocol (the __iter__() method), or it must support the sequence protocol (the __getitem__() method with integer arguments starting at 0). If it does not support either of those protocols, TypeError is raised.

This terminology is misleading, since a "collection" also needs to support size and containment checking. Per set and Collections Abstract Base Classes, respectively:

Like other collections, sets support x in set, len(set), and for x in set.

Collection : Sized, Iterable, Container : __contains__, __iter__, __len__

It should be possible to reword this section to avoid the term "collection", either by simply removing it or rephrasing the whole sentence.

Linked PRs
  • gh-155857

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit der Form von iter() mit einem Argument in der Dokumentation zu den eingebauten Funktionen. Überprüfe die Formulierung rund um die Protokolle „iterable“ und „sequence“ und bestätige anschließend, dass der Begriff „collection“ entfernt oder umformuliert wird, damit er nicht impliziert, dass Unterstützung für Größe und Enthaltensein vorhanden ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
1/5
Geschätzter Aufwand
Unter einer Stunde
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
30/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.