More ideas about plugin system
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 20.6k
- Forks
- 3.3k
- PR-Merge-Kennzahlen
- PR-Kennzahlen ausstehend
Beschreibung
After some time spent on writing SQLAlchemy plugin and a discussion with @JukkaL here are some comments and ideas about our plugin :
-
Currently, member signature hook is not called on
__init__and__new__. Current workaround is to use function hook, but it is still painful. The solution would require movingtype_object_type()(and maybe a bunch of other helpers) fromcheckmember.pyto a separate module (which is probably a good idea on its own). We can also move some helpers fromchecker.pyrelated to type objects to the same module. -
During semantic analysis types of expressions are not known. This poses a problem in attrs and even more in SQLAlchemy: When generating an
__init__method for a model, plugin needs to figure out what is a type of attributes from definitions likename = Column(String(40)). Currently I do this using some heuristics that works in 95% of cases (and so does attrs plugin), but a better solution is probably to just store names of "magic" classes (SQLAlchemy models, dataclasses etc.) in the plugin state, add a dummy__init__to symbol table, and defer figuring out actual type to the method signature hook that is called in type checking (depends on fixing previous bullet). -
It is better to move calling semantic analysis hooks to the very end, or (probably even better) just allow them to defer current target (but this is currently not possible).
-
We should not allow most type operations in semantic analysis hooks (we can't enforce it, but should at least document it clearly). Some operations are still OK (like
map_instance_to_supertype()orerase_type()). -
The type checking hooks should also be able to defer current target using a special return value or an exception (e.g.
__init__signature hook in the SQLAlchemy example above if one would use a user-defined type in an import cycle).
Probably, most (or all) of decisions should be made after the upcoming semanal.py refactoring.
(Also function hook is inconvenient, but @gvanrossum already mentioned this in https://github.com/python/mypy/issues/5409 that has a bunch of good ideas about improving plugin system.)
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 damit, die pluginbezogene Logik in checkmember.py und checker.py zu lesen, und prüfe anschließend die geplante Refaktorierung von semanal.py sowie das verknüpfte Issue #5409. Das Issue führt mehrere Designfragen zu Hooks für semantische Analyse und Typprüfung auf, definiert jedoch weder eine einzelne Änderung noch ein konkretes Abschlusskriterium.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- compilers
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 25/100