[spec] Formalize excluded Protocol members

Offen

#1,833 erstellt am 06.8.2024 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 5/5
Geschätzter Aufwand: Über eine Woche
Anfängerfreundlichkeit: 35/100

Issue-Typ: Dokumentation
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: python
Bereich: documentation

Rechercherichtung

Beginne mit der EXCLUDED_ATTRIBUTES-Definition in Lib/typing.py und vergleiche sie mit PEP 544, der typing specification sowie den verlinkten pyright- und mypy-Beispielen. Bestimme, welche Protocol-Mitglieder eine formale Spezifikation erfordern, und dokumentiere das beabsichtigte Verhalten, damit die unterschiedlichen Ergebnisse der Checker eindeutig aufgelöst werden können.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

topic: documentation

At runtime, the following members are currently excluded by Protocol: (source)

_TYPING_INTERNALS = frozenset({
    '__parameters__', '__orig_bases__',  '__orig_class__',
    '_is_protocol', '_is_runtime_protocol', '__protocol_attrs__',
    '__non_callable_proto_members__', '__type_params__',
})


_SPECIAL_NAMES = frozenset({
    '__abstractmethods__', '__annotations__', '__dict__', '__doc__',
    '__init__', '__module__', '__new__', '__slots__',
    '__subclasshook__', '__weakref__', '__class_getitem__',
    '__match_args__', '__static_attributes__', '__firstlineno__',
    '__annotate__',
})


# These special attributes will be not collected as protocol members.
EXCLUDED_ATTRIBUTES = _TYPING_INTERNALS | _SPECIAL_NAMES | {'_MutableMapping__marker'}

However, neither PEP 544 nor the typing spec formalize this list, which leads to diverging behavior between different type checkers:

Code sample in pyright playground, mypy playground

from typing import TypeIs, Protocol

class MyProtocol(Protocol):
    @classmethod
    def __subclasshook__(cls, other: type, /) -> TypeIs[type["MyProtocol"]]:
        ...

x: MyProtocol = int(1)  # mypy: ✅ pyright: ❌

Code sample in pyright playground, mypy playground

from typing import Protocol

class MyProtocol(Protocol):
    __abstractmethods__: frozenset[str]
    
x: MyProtocol = int(1)  # mypy: ✅ pyright: ❌

A real-world example where this matters is for instance a Protocol for NamedTuple Instances, that checks whether types.get_original_bases(cls) includes typing.NamedTuple inside __subclasshook__.

Vorherrschende Sprache: Python
Sterne: 1.8k
Forks: 302
Ø Merge: 23 Std.
Gemergte PRs (30 T.): 8

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus python/typing

Spec: `Final` section could use better definition for `Final` vs. `Final[X]` Offen

topic: typing spec

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100

python/typing#2356 · 2 Kommentare · 1 Reaktion · Erstellt am 02.9.2026
Spec: PEP leftovers in the spec for literals Offen

topic: typing spec

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100

python/typing#2355 · Erstellt am 01.9.2026
Update reference/generics.html with PEP695 type parameter syntax Offen

topic: documentation

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 76/100

python/typing#2227 · 2 Kommentare · Erstellt am 25.3.2026
Remove PEP references in Typing Python Libraries guide Offen

topic: documentation

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100

python/typing#2150 · 2 Kommentare · 2 Reaktionen · Erstellt am 12.1.2026
Finals and Literals: Spec contradiction Offen

topic: conformance tests topic: typing spec

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 72/100

python/typing#2351 · 2 Kommentare · Erstellt am 31.8.2026

Alle Issues in python/typing