Subtle pattern in the __subclasshook__ docs isn't explained
還沒有人認領這個 Issue。
- 主要語言
- Python
- 星號
- 77.2k
- 分支
- 36k
- 平均合併
- 1 天 9 小時
- 30 天內合併 PR
- 558
描述
Documentation
The docs for subclasshook[0] contains the following example:
from abc import ABC
class MyIterable(ABC):
...
@classmethod
def __subclasshook__(cls, C):
if cls is MyIterable:
if any("__iter__" in B.__dict__ for B in C.__mro__):
return True
return NotImplemented
The docs state that "This method should return True, False or NotImplemented" but the example given only returns True | NotImplemented. This makes it hard for the user to understand how to use the method themselves.
In particular it's not clear to the reader:
- Why they may want to return
NotImplementedinstead ofFalse(this is a common pattern used in stdlib ABCs). - That returning
Falsein__subclasshook__will override the registration of a class due to theissubclassalgorithm. [1][2]
[0] https://docs.python.org/3.12/library/abc.html#abc.ABCMeta.__subclasshook__
[1] Demonstration of this:
from abc import ABC
class Iterable(ABC):
@classmethod
def __subclasshook__(cls, subclass):
return hasattr(subclass, "__iter__")
class NotIterable:
"""Does not define __iter__."""
Iterable.register(NotIterable)
assert issubclass(NotIterable, Iterable)
# 'AssertionErrror'
[2] My understanding of the issubclass algorithm is described in this comment: https://github.com/python/cpython/issues/61035#issuecomment-1361180346
Linked PRs
- gh-100453
- gh-100503
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
從 issue 中連結的 abc.ABCMeta.subclasshook 文件開始,並查看所參照的 issubclass 討論。將現有範例與 True、False 和 NotImplemented 的所述行為進行比較,然後更新說明並新增或修改範例,以清楚呈現其中的區別。開始之前檢查連結的 PR gh-100453 和 gh-100503。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- python
- 領域
- documentation
- Issue 類型
- 文件
- 難度
- 3/5
- 預估耗時
- 1-2 天
- 活躍度
- 停滯
- 描述清晰度
- 描述清楚
- 新手友好度
- 25/100