Make abstract/dunder methods positional-only.
還沒有人認領這個 Issue。
- 主要語言
- Python
- 星號
- 77.2k
- 分支
- 35.9k
- PR 合併指標
- PR 指標待擷取
描述
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
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
從 Lib/_collections_abc.py 和 typeshed/stdlib/typing.pyi 中引用的定義開始,接著檢視連結的 PR gh-136324 以及相關的 typeshed issue。完成的標準是:在 CPython 中更新約定的抽象方法和 dunder 方法簽名,並處理文件中說明的向後相容性疑慮。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- python
- 領域
- compilers
- Issue 類型
- 功能
- 難度
- 4/5
- 預估耗時
- 3-5 天
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 25/100