Entwicklungsumgebung

Wie kann man die eigene Entwicklungsumgebung konfigurieren, um bestmöglich mitwirken zu können?

Bewährt hat sich VSCode https://code.visualstudio.com/, hinzu kommen noch ein paar Plugins. Am einfachsten direkt nach der Installation von VSCode in den Erweiterungen danach suchen und installieren:

• GitHub - für die Codeverwaltung, Erstellen von PRs & Co.
• Flake8 (ich musste aus dem Dropdown explizit das Prerelease auswählen) - Überprüft die Code-Formatierung von Python direkt im Editor. Ist optional, wird beim Erstellen eines PRs aber im Repo überprüft und der PR geht im Zweifel zurück an euch.
• Remote Development - ebenfalls optional, erlaubt es aber, direkt auf einem Raspberry Pi zu arbeiten. Auch für Live-Debugging & Co. sehr hilfreich.
• Remote SSH - benötigt für das Remote Development auf einem Raspberry Pi
• Code Spell Checker - optional, aber empfehlenswert. Prüft die Rechtschreibung und kann sogar mit CamelCase und underscore_naming umgehen. Dazu auch gleich das Wörterbuch für Deutsch installieren: "German - Code Spell Checker". Wird "Remote Development" genutzt, so ist die Erweiterung auch auf dem über SSH verbundenen Raspberry Pi zu installieren. Dies kann ebenfalls einfach in VSCode bei den Erweiterungen erledigt werden, wenn man bereits mit dem Raspberry Pi verbunden ist. Damit der Code auch überprüft wird, müssen noch die zu prüfenden Dateitypen festgelegt werden. Dazu entweder den Haken der Einstellung "C Spell: Check Only Enabled File Types" entfernen, um alle Dateitypen zu aktivieren, oder direkt darunter in "C Spell: Enable Filetypes" einzelne Dateiendungen definieren.

Genereller Ablauf, um eigene Änderungen beisteuern zu können:

• Eigenen GitHub-Account erstellen
• openWB core Repository in den eigenen Account kopieren ("forken"), um eine editierbare Version zu erhalten: https://github.com/openWB/core/fork
• Gegen diese eigene Kopie kann nun gearbeitet werden. Hierzu in VSCode in der Kommandozeile oben git clone starten, auf die URL des eigenen Repos zeigen. Diese URL endet auf .git und findet sich in GitHub hinter dem Button Code.
• Es empfiehlt sich unbedingt, für Änderungen stets einen separaten Branch zu öffnen, um das nächste Mal nicht wieder die ganzen alten Änderungen mitzuschleifen. Links unten in VSCode auf den Namen des Branches (master) klicken und einen neuen erstellen.
• Die Änderungen durchführen und testen.
• Wenn alles passt, in der Quellcodeverwaltung die geänderten Dateien mit dem '+' auswählen und eine kurze Beschreibung hinzufügen. Mit Klick auf Commit werden die Änderungen in das eigene Repo übertragen.
• Testen.
• Wenn alles passt, einen Pull Request (PR) gegen das offizielle Repo erstellen: GitHub in VSCode auswählen, rechts neben 'PULL REQUESTS' findet sich ein 'Create Pull Request' - überprüfen, ob das Ziel wirklich master in openWB/Core ist, was eigentlich der Fall sein sollte. Änderungen auswählen, auch diese sollten bereits vorselektiert sein, kurze Beschreibung, und PR absetzen.

Hört sich jetzt schlimmer an, als es ist. Wenn man den Prozess einmal durch hat, ist das kein Drama mehr.

Einrichtung Remote Development:

Hier gibt es eine kurze Übersicht: https://www.raspberrypi.com/news/coding-on-raspberry-pi-remotely-with-visual-studio-code/

hier braucht es noch mehr Details, ggf. ein Screenshot?

Für Live-Debugging eine Remote-Session starten, openwb2.service beenden und main.py direkt in VSCode über 'Ausführen und Debuggen' starten. Ggf. muss hier einmalig die passende Umgebung (SSH) ausgewählt werden.

Flake8

Nach dem Erstellen eines PRs gegen das offizielle Repo werden automatisiert einige Tests durchgeführt. Schlagen diese fehl, muss der PR korrigiert werden. Flake8 ist einer dieser Tests und überprüft/forciert saubere Code-Formatierung.

Um nun zu vermeiden, dass man dies unnötig häufig macht, empfiehlt es sich, unbedingt Flake8 direkt selbst in VSCode zu aktivieren und die Fehler und Warnungen zu korrigieren.

Fehler und Warnungen findet man im Tray von VSCode:

In der Ausgabe im Reiter Probleme:

Und auch inline direkt im Editor:

Bezeichnungen für eigene Variablen, Funktionen

Bitte an die allgemeinen Namenskonventionen für Python halten: https://realpython.com/python-pep8/#naming-conventions

Die vorgeschlagene Erweiterung "Code Spell Checker" kann mit fast allen Varianten umgehen. Lediglich die empfohlene Bezeichnung für eigene Pakete (packages) kann nicht geprüft werden, da nur Kleinbuchstaben genutzt und die zusammengesetzten Wörter nicht von einem Tippfehler unterschieden werden können.

PyTest

Neben der Formatierung werden auch automatisierte Funktionstests durchgeführt. Auch diese können in VSCode bereits vor dem Absenden des PRs durchgeführt werden. Zu finden sind die Tests links im Navigationsbaum von VSCode. Bei der ersten Nutzung muss noch 'pytest' als Testplattform ausgewählt werden. Anschließend kann man im Navigationsbaum einzelne oder alle Tests starten und überprüfen, ob diese erfolgreich waren. Fehler werden direkt im Code der jeweiligen Tests angezeigt, um den Test ggf. anpassen zu können.

Um sich das Leben einfach zu machen, sollte man spätestens hier die Variante 'Remote-Development' wählen. Das stellt sicher, dass die notwendigen Module allesamt vorhanden sind.