Assuming `self` or `cls` parameter is positional-only
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 1.8k
- Forks
- 302
- Ø Merge
- 23 Std.
- Gemergte PRs (30 T.)
- 8
Beschreibung
I'm interested in guidance from the typing community relating to a question that came up in a recent pyright bug report.
The issue has to do with the self parameter in an instance method and the cls parameter in a class method — whether a type checker should assume that they are implicitly positional-only parameters. In particular, the discussion was about method declarations within a protocol class.
PEP 570 makes a reference to this topic in its introductory section:
One special case of this situation is the
selfparameter for class methods: it is undesirable that a caller can bind by keyword to the nameselfwhen calling the method from the class.
But PEP 570 doesn't provide any specific guidance about self or cls in its specification section. PEP 544 (which introduced protocols) is also silent on the topic.
Pyright currently assumes that self and cls are not positional-only parameters (unless explicitly followed by a / parameter marker or named with double underscores). This assumption affects protocol matching — and more generally, subtype compatibility evaluation for callables.
@AlexWaygood is proposing that the first parameter of instance and class methods should always be considered position-only parameters.
This raises some questions in my mind:
- Is this a safe assumption? Does anyone know of a situation where
selforclsare used as keyword arguments? - Does this apply only to protocol methods, or does it apply generally to methods in any class?
- Should it be considered a type checker error if someone attempts to use a keyword argument to target the first parameter of an instance or class method? It works at runtime.
class Foo:
def bar(self): pass
Foo.bar(self=Foo())
- Does the
clsexemption apply only to explicit class methods, or does it also apply to__new__and__init_subclass__?
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
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
Lies zunächst PEP 570 und PEP 544, und prüfe anschließend den verknüpften Pyright-Fehlerbericht sowie die Diskussion zum Issue. Ermittle, ob self und cls bei Methoden, Protokollen, new und init_subclass als positions_only behandelt werden sollten. Erledigt ist dies, wenn eine dokumentierte Community-Empfehlung oder eine Spezifikationsentscheidung erreicht wurde.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- tooling
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 20/100