`None` vs `Never` as `typing.Generator`'s send type
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 77.2k
- Forks
- 35.9k
- PR-Merge-Kennzahlen
- PR-Kennzahlen ausstehend
Beschreibung
Documentation
Documentation for typing.Generator currently says:
If your generator will only yield values, set the
SendTypeandReturnTypetoNone
While not obviously wrong, using None as SendType looks imprecise: we want a typechecker to warn about .send(t) calls for any t, right? Using that method likely indicates that the generator is used incorrectly.
Now type checkers will reject .send(t) calls for all t types except None and Any.
Since python 3.11 we have a Never type - effectively a "please don't" type. So setting SendType to Never instead of None would be more useful from the interface declaration perspective: literally saying "please don't send anything here".
I do understand that None is there to match runtime behaviour closer since calling it.send(None) is equivalent to calling next(it) for the next time, so None is formally correct. However, there's no benefit ever from doing it.send(None) if the generator does not use sent values - calling next(it) is clearly preferable.
My suggested solution is to recommend typing.Never as SendType in such cases in documentation. I'm ready to write a PR with this change.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit der verlinkten typing.Generator-Dokumentation und prüfe die Hinweise zu SendType und ReturnType. Sieh dir vor dem Fortfahren die Diskussion mit fünf Kommentaren an, da der Issue in letzter Zeit keine Aktivität hatte. Als abgeschlossen gilt die Aufgabe, wenn die Dokumentation die geklärte Empfehlung für Generatoren widerspiegelt, die keine gesendeten Werte akzeptieren.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100