Fünf wichtige Tipps zur Verbesserung der Lesbarkeit von Python-Code

Übersetzer |. Zhao Qingyu

Rezensent |. Schauen Sie oft auf den Code zurück, den Sie vor 6 Monaten geschrieben haben, und möchten Sie wissen, was in diesem Code vor sich geht? Ich weiß nicht, wo ich anfangen soll. Diese Situation kommt bei Entwicklern relativ häufig vor. Es gibt viele Methoden in Python, die uns helfen, das Innenleben von Code zu verstehen. Wenn Sie also den Code von Anfang an betrachten oder Code schreiben, sollte es einfacher sein, dort fortzufahren, wo Sie aufgehört haben.

Hier gebe ich Ihnen ein Beispiel. Möglicherweise erhalten wir den unten gezeigten Code. Das ist nicht das Schlimmste, aber es gibt einige Dinge, die wir bestätigen müssen, wie zum Beispiel:

Wofür stehen f und d in der Funktion „load_las_file“

• Warum überprüfen wir die Ergebnisse in der Clay-Funktion? Diese Funktionen erfordern welchen Typ: Floats oder DataFrames?

In diesem Artikel werde ich 5 grundlegende Tipps behandeln, wie Sie die Lesbarkeit Ihrer Anwendung/Ihres Skripts durch Dokumentation, Eingabeaufforderung und geeignete Variablennamen verbessern können.

1. Kommentare

Als Erstes können wir dem Code Kommentare zu bestimmten Zeilen hinzufügen. Achten Sie jedoch darauf, nicht zu viele Kommentare abzugeben. Kommentare müssen erklären, warum der Code funktioniert oder warum etwas auf eine bestimmte Art und Weise gemacht wird, und nicht, wie es implementiert wird. Kommentare in Python werden normalerweise mit dem Nummernzeichen (#) vervollständigt, das eine oder mehrere Zeilen umfassen kann.

# Comment using the hashtag
# Another comment using the hashtag

Für mehrzeilige Kommentare können wir auch doppelte Anführungszeichen verwenden.

"""
This is an example of
a multi-line comment
"""

Im folgenden Beispiel wurden einige Kommentare zum Code hinzugefügt, um zu erklären, wie bestimmte Codezeilen funktionieren und warum:

2. Explizite Typisierung

Die Python-Sprache ist dynamisch typisiert, was bedeutet, dass es sich um Variablentypen handelt wird nur zur Laufzeit überprüft. Darüber hinaus können Variablen während der Codeausführung ihren Typ ändern. Bei der statischen Typisierung hingegen wird der Variablentyp explizit deklariert und kann sich während der Codeausführung nicht ändern.

Im Jahr 2014 führte PEP 484 das Konzept der Typhinweise ein, und dieses Konzept wurde anschließend in Python 3.5 eingeführt. Dadurch können Sie Variablentypen explizit deklarieren. Durch das Hinzufügen von Typhinweisen können Sie die Lesbarkeit Ihres Codes erheblich verbessern. Im folgenden Beispiel sehen wir:

erfordert zwei Parameter

Der Typ des Parameters Dateiname ist String

• Der Typ des Parameters start_ Depth ist vom Typ Float und der Standardwert dieses Parameters ist None
• Die Funktion wird zurückgegeben Ein Pandas DataFrame-Objekt

Anhand der Typhinweise wissen wir genau, was die Funktion benötigt und was sie zurückgeben wird.

3. Dokumentationszeichenfolge

Dokumentationszeichenfolge ist die Zeichenfolge, die unmittelbar auf die Funktions- oder Klassendefinition folgt. Docstrings sind eine großartige Möglichkeit, im Detail zu erklären, was eine Funktion tut, welche Argumente sie akzeptiert, welche Ausnahmen sie auslöst, welchen Rückgabewert sie hat und vieles mehr. Wenn Sie außerdem ein Tool wie Sphinx verwenden, um eine Online-Dokumentation für Ihren Code zu erstellen, werden die Dokumentzeichenfolgen automatisch extrahiert und in die entsprechende Dokumentation konvertiert. Das folgende Beispiel zeigt die Dokumentzeichenfolge für eine Funktion namens clay_volume. Hier können wir die Bedeutung jedes Parameters angeben. Dies macht es detaillierter als einfache Typhinweise. Sie können auch weitere Informationen über die Methodik hinter der Funktion hinzufügen, beispielsweise wissenschaftliche Referenzen oder Gleichungen.

Doc-Strings sind auch sehr hilfreich, wenn wir Funktionen an anderer Stelle im Code aufrufen. Wenn Sie beispielsweise Code mit Visual Studio schreiben, können Sie mit der Maus über einen Funktionsaufruf fahren und ein Popup sehen, das zeigt, was die Funktion tut und was sie erfordert.

Wenn Sie Visual Studio Code (VS Code) zum Bearbeiten Ihres Python-Codes verwenden, können Sie Erweiterungen wie autoDocstring verwenden, um das Erstellen von Docstrings zu vereinfachen. Sie können drei doppelte Anführungszeichen eingeben und der Rest der Vorlage wird automatisch ausgefüllt. Sie müssen nur die Details ausfüllen.

Tipp: Wenn Sie Typen in den Parametern deklariert haben, werden diese automatisch ausgewählt.

4. Lesbare Variablennamen

Manchmal sind Ihnen die Namen von Variablen beim Schreiben von Code egal, insbesondere wenn die Zeit knapp ist. Wenn Sie jedoch zurückgehen und sich den Code ansehen und eine Reihe von Variablen mit den Namen x1 oder var123 finden, verstehen Sie möglicherweise nicht auf den ersten Blick, was sie darstellen. Im folgenden Beispiel gibt es zwei Variablen f und d. Wir können die Bedeutung solcher Variablen erraten, indem wir uns andere Teile des Codes ansehen. Dies kann jedoch einige Zeit dauern, insbesondere wenn der Code lang ist.

Wenn wir diesen Variablen geeignete Namen geben, können wir erkennen, dass eine der Variablen die vom Aufruf lasio.read() gelesene Datendatei ist und höchstwahrscheinlich die Originaldaten. Die Datenvariable sagt uns, dass es sich hierbei um die tatsächlichen Daten handelt, mit denen wir es zu tun haben.

5. Vermeiden Sie magische Zahlen

Magische Zahlen sind Werte im Code, die eine ungeklärte Bedeutung haben und Konstanten sein können. Die Verwendung dieser Werte im Code kann zu Mehrdeutigkeiten führen, insbesondere wenn Sie mit der Verwendung von Zahlen in Berechnungen nicht vertraut sind. Wenn wir außerdem dieselbe magische Zahl an mehreren Stellen haben und sie aktualisiert werden muss, müssen wir jede Instanz davon aktualisieren. Wenn solchen Zahlen jedoch eine entsprechend benannte Variable zugewiesen wird, wird der Ersetzungsprozess viel einfacher. Im folgenden Beispiel haben wir eine Funktion, die einen Wert namens Ergebnis berechnet und ihn mit 0,6 multipliziert. Was bedeutet das? Ist es ein Skalar?

Wenn wir eine Variable deklarieren und ihr den Wert zuweisen, wissen wir eher, was es ist. In diesem Fall wird das Verhältnis von Ton zu Schiefer verwendet, um den Gammastrahlenindex in Tonvolumen umzurechnen.

6. Endgültiger Code

Nachdem wir die oben genannten Tipps angewendet haben, sieht unser endgültiger Code jetzt klarer und verständlicher aus.

7. Zusammenfassung

Das Hinzufügen von Erklärungen zu Ihrem Code durch Kommentare und Dokumentzeichenfolgen kann Ihnen und anderen helfen, zu verstehen, was der Code tut. Es mag sich zunächst wie eine lästige Pflicht anfühlen, aber mit der Verwendung der Werkzeuge und regelmäßiger Übung wird es zur zweiten Natur.

Originallink: https://towardsdatascience.com/5-essential-tips-to-improve-the-readability-of-your-python-code-a1d5e62a4bf0

Einführung in den Übersetzer

Zhao Qingyu, 51CTO-Community-Redakteur, engagiert in jahrelanger treibender Entwicklung. Seine Forschungsinteressen umfassen sichere Betriebssysteme und Netzwerksicherheitsbereiche und er hat netzwerkbezogene Patente veröffentlicht.

Das obige ist der detaillierte Inhalt vonFünf wichtige Tipps zur Verbesserung der Lesbarkeit von Python-Code. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!