Namensgebung: Best Practices in Python

Als Phil Karlton in den 1990ern bei Netscape arbeitete, prägte er das Zitat „[There are only two hard things in Computer Science: cache invalidation and naming things.]“, was halb ein Scherz, aber zur anderen Hälfte auch sein voller Ernst war. Wieviel Wahrheit in diesem Ausspruch steckt, sieht man sofort, wenn man einen Blick auf fremden Code wirft. Wir wollen uns hier einmal kurz ein paar Tipps ansehen, wie man in Python Namen vergeben sollte.

Es gibt einige allgemeine Best Practices, die bei der Namensgebung von Python-Skripten zu beachten sind:

  1. Verwende konsistente Namenskonventionen: Es ist wichtig, konsistente Namenskonventionen für Skripte und andere Dateien in deinem Projekt zu verwenden. Dies kann dazu beitragen, die Lesbarkeit und Wartbarkeit des Codes zu verbessern.
  2. Vermeide Sonderzeichen: Vermeide es, Sonderzeichen wie Punkte, Kommas oder Leerzeichen in den Namen von Skripten zu verwenden. Dies kann zu Problemen führen, wenn du das Skript ausführen möchtest, da viele Betriebssysteme diese Zeichen nicht in Dateinamen erlauben.
  3. Verwende keine reservierten Wörter: Vermeide es, reservierte Wörter wie „for“ oder „while“ in den Namen von Skripten zu verwenden, da diese Wörter bereits von Python reserviert sind und nicht als Dateinamen verwendet werden können.
  4. Verwende kurze, prägnante Namen: Versuche, kurze, prägnante Namen für deine Skripte zu verwenden, die den Zweck des Skripts klar beschreiben. Dies kann dazu beitragen, den Code leichter lesbar und verständlicher zu machen.
  5. Verwende camelCase oder snake_case: Wenn du Namen mit mehreren Wörtern verwendest, solltest du entweder camelCase (z.B. „myScriptName“) oder snake_case (z.B. „my_script_name“) verwenden, um den Code lesbarer und einfacher zu lesen.

Es ist auch wichtig, sich an die Konventionen für die Namensgebung in deinem Team oder deiner Organisation zu halten, wenn vorhanden. Auf diese Weise wird sichergestellt, dass alle in der Organisation verwendeten Skripte einheitlich benannt werden und der Code für alle Teammitglieder leicht verständlich ist.

Wie in so vielen Bereichen können wir auch hier auf computerisierte Unterstützung setzen, denn ein sogenannter „Linter“ kann uns dabei helfen, Einheitlichkeit in unserem Code zu schaffen und uns darauf hinweisen, wenn wir von den Namenskonventionen abweichen.

Den Einsatz von Lintern in Python sehen wir uns in einem Folgebeitrag genauer an.