- Eine vorgeschlagene Bibliothek, um spezielle Kommentare (Action Comments), die im Python-Ökosystem von Lint-, Formatter-, Type-Checker- und Coverage-Tools verwendet werden, in einem einzigen Standard zu vereinheitlichen
- Ziel ist es, die Verwirrung rund um Kommentar-Syntaxen zu beseitigen, die de facto Konventionen sind, aber keinen Standard haben, wie
# noqa, # fmt: off oder # type: ignore
- Definiert eine leichtgewichtige Kommentarsprache (metacode), die eine Teilmenge der Python-Syntax verwendet
- Klare Trennung von Tool, Aktion und Argumenten in der Form
key: action[arguments]
- Unterstützt eine Struktur, in der Kommentare für mehrere Tools sicher in derselben Codezeile koexistieren können
- Kombinationen wie
# type: ignore # fmt: off lassen sich verarbeiten
- Stellt einen offiziellen Parser (
parse) für das Parsen von Kommentaren bereit, wodurch String- und Regex-Parselogik entfällt, die bisher von jedem Tool separat implementiert wurde
- Unterstützt als Argumenttypen Strings, Zahlen, Bool,
None, Ellipsis usw.; bei Bedarf ist auch erweitertes AST-basiertes Parsing möglich
- Bestimmte Keys können selektiv geparst werden, wodurch sich die Lösung gut für die getrennte Verarbeitung von tool-spezifischen Kommentaren eignet
- Bietet eine
insert-API zum automatischen Erzeugen und Einfügen von Kommentaren
- Die Syntax selbst ist in EBNF spezifiziert, damit sie nicht an Python gebunden ist und auch in anderen Sprachen implementiert werden kann
Noch keine Kommentare.