Make abstract/dunder methods positional-only.
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 77.2k
- Forks
- 35.9k
- PR-Merge-Kennzahlen
- PR-Kennzahlen ausstehend
Beschreibung
Feature or enhancement
It would be nice if certain abstract methods / dunder methods would be defined with positional-only arguments, so that when one subclasses them an appropriate name can be chosen, or they can be defined positional-only in the subclass.[^1]
Code sample in pyright playground[^1]
from typing import overload
from collections.abc import Sequence
class MySequence[T](Sequence[T]):
def __len__(self): return 0
@overload
def __getitem__(self, idx: int, /) -> T: ...
@overload
def __getitem__(self, idx: slice, /) -> Sequence[T]: ...
def __getitem__(self, idx: int | slice, /) -> T | Sequence[T]: # ❌ override
return MySequence[T]()
In some cases, the stubs already fake that the argument is positional-only, such as for Container.__contains__:
def __contains__(self, x: object, /) -> bool: ...intypeshed/stdlib/typing.pyidef __contains__(self, x):incpython/Lib/_collections_abc.py
Personally, I think only changing the stubs would be a pragmatic choice, but I was told by the maintainers that they believe this change should be done in Cpython first.
Backward Compatibility
-
Changing non-abstract methods can potentially break user code. For example, this is currently legal code at runtime
from collections.abc import Container. Container.__subclasshook__(C=list) # True -
Changing the signature of abstract methods can introduce type-checker errors Code sample in pyright playground[^1]
from collections.abc import Sequence def get(x: Sequence[float], index: int) -> float: return x.__getitem__(index=index)
With this in mind, I believe changing abstrac dunder methods to use positional only arguments should be relatively safe, as calling them directly with keyword is very uncommon, and at worst it will introduce type errors.
Personally, I'd also like so see methods like Container.__subclasshook__ use positional-only arguments, but I also understand if this is not feasible due to bc-conerns.
[^1]: Note that mypy special cases certain dunder methods, and yields different results than pyright on these examples
Has this already been discussed elsewhere?
https://github.com/python/typeshed/issues/14071
Linked PRs
- gh-136324
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 den zitierten Definitionen in Lib/_collections_abc.py und typeshed/stdlib/typing.pyi und prüfe anschließend den verlinkten PR gh-136324 sowie das zugehörige typeshed issue. Als abgeschlossen gilt die Arbeit, wenn die vereinbarten abstrakten und Dunder-Methodensignaturen in CPython aktualisiert sind und die dokumentierten Bedenken zur Abwärtskompatibilität berücksichtigt wurden.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- compilers
- Issue-Typ
- Feature
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 25/100