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

Es gibt viele Methoden in Python, die uns helfen können, das Innenleben des Codes zu verstehen, können unsere Arbeit mit halbem Aufwand effektiver machen!

Am Ende erhalten wir möglicherweise Code, der dem Bild unten sehr ähnlich sieht. Nicht das Schlimmste, aber wir müssen einige Dinge näher erläutern, wie zum Beispiel:

• load_las_file Wofür stehen f und d in der Funktion „load_las_file“?
• Warum überprüfen wir das Ergebnis in der Clay-Funktion?
• Welche Typen sind für diese Funktionen erforderlich? Floats? DataFrames?

In diesem Artikel konzentrieren wir uns darauf, wie Sie Ihre Anwendung durch Dokumentation, schnelle Eingabe und korrekte Variablen verbessern können Namen Fünf grundlegende Tipps für die Lesbarkeit von Programmen/Skripten.

1. Kommentare

Das erste, was wir an unserem Code tun können, ist, einige Kommentare zu unserem Code hinzuzufügen, aber verwenden Sie ihn nicht zu häufig. Kommentare sollten Ihnen sagen, warum der Code funktioniert oder warum etwas auf eine bestimmte Weise gemacht wird, und nicht, wie es funktioniert.

Kommentare in Python werden normalerweise mit dem Nummernzeichen (#) erstellt und können sich über eine einzelne Zeile oder mehrere Zeilen erstrecken.

# Comment using the hashtag
# Another comment using the hashtag

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

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

Im folgenden Beispiel wurden dem Code einige Kommentare hinzugefügt, um den Arbeitsablauf und die Argumentation hinter bestimmten Codezeilen zu erläutern

# 🎜🎜#2. Explizite Typisierung

Die Python-Sprache ist dynamisch typisiert, was bedeutet, dass Variablentypen nur zur Laufzeit überprüft werden. Darüber hinaus können Variablen während der Codeausführung ihren Typ ändern.

Statische Typisierung hingegen beinhaltet die explizite Angabe des Typs einer Variablen und dieser kann sich während der Ausführung des Codes nicht ändern.

Im Jahr 2014 führte PEP 484 das Konzept der Typhinweise ein, die später in Python Version 3.5 eingeführt wurden. Diese ermöglichen es uns, explizit anzugeben, welchen Typ eine Variable haben soll.

Durch das Hinzufügen von Typhinweisen können Sie die Lesbarkeit Ihres Codes erheblich verbessern. Im folgenden Beispiel können wir leicht die folgenden Informationen erhalten:

Die Funktion erfordert zwei Parameter
• Der Dateinamenparameter sollte vom Typ Zeichenfolge sein#🎜🎜 #
• Start_Tiefe-Parameter sollte vom Typ Float sein, der Standardwert ist None
• Diese Funktion gibt ein Pandas-DataFrame-Objekt zurück

# 🎜🎜 #

Wir können anhand von Typhinweisen sofort genau erkennen, was die Funktion benötigt und was sie zurückgeben wird.

3. Docstrings (Dokumentationsstrings)

Docstrings sind String-Literale, die einer Funktions- oder Klassendefinition folgen und eine großartige Möglichkeit sind, im Detail zu erklären, was unsere Funktion tut , welche Argumente sind erforderlich, welche Ausnahmen werden ausgelöst, was wird zurückgegeben usw.

Wenn wir außerdem ein Tool wie Sphinx verwenden, um eine Online-Dokumentation für unseren Code zu erstellen, werden die Dokumentzeichenfolgen automatisch abgerufen und in die entsprechende Dokumentation umgewandelt.

Das folgende Beispiel zeigt die Dokumentzeichenfolge für eine Funktion namens clay_volume .

Hier können wir angeben, was jeder Parameter ist, was detaillierter ist als einfache Typhinweise, und wir können auch weitere Informationen über die Methode hinter der Funktion hinzufügen, wie z. B. wissenschaftliche Referenzen oder Gleichungen.

Eine Dokumentzeichenfolge ist auch sehr hilfreich, wenn wir Funktionen von einer anderen Stelle im Code aufrufen. Wenn Sie beispielsweise Code mit Visual Studio bearbeiten, können Sie den Mauszeiger über einen Funktionsaufruf bewegen und ein Popup mit Informationen zu den Funktionen und Anforderungen der Funktion anzeigen.

Wenn Sie Visual Studio Code (VSCode) zum Bearbeiten unseres Python-Codes verwenden, können Sie Erweiterungen wie autoDocstring verwenden, um den Prozess der Erstellung von Dokumentzeichenfolgen zu vereinfachen. Das Plugin ermöglicht uns die Eingabe von drei doppelten Anführungszeichen und füllt den Rest der Vorlage automatisch aus. Wir müssen uns nur auf die anderen Details konzentrieren, die ausgefüllt werden müssen.

4. Lesbare Variablennamen

Oft achten wir beim Schreiben von Code nicht besonders auf die Namen von Variablen, insbesondere wenn wir bestimmte Funktionen ausführen möchten. Wenn unser Code jedoch eine Reihe von Variablen mit den Namen x1 oder var123 zurückgibt, kann niemand auf den ersten Blick verstehen, was sie darstellen.

Im Beispiel unten haben wir zwei Variablen f und d. Es ist möglich, zu erraten, was diese bedeuten, indem man sich andere Teile des Codes ansieht. Dies dauert jedoch einige Zeit, insbesondere wenn der Code lang ist.

Wenn wir diesen Variablen entsprechende Namen zuweisen, können wir erkennen, dass eine davon die vom Aufruf lasio.read() gelesene Datendatei ist und höchstwahrscheinlich die Originaldaten ist, und die Datenvariable gibt Auskunft darüber uns, dass es sich hierbei um die tatsächlichen Daten handelt.

5. Magische Zahlen vermeiden

Magische Zahlen sind Werte im Code, die viele ungeklärte Bedeutungen haben und Konstanten darstellen können. Die Verwendung dieser Werte im Code kann zu Unklarheiten führen, insbesondere für diejenigen, die mit Berechnungen, in denen Zahlen verwendet werden, nicht vertraut sind.

Wenn wir dieselbe magische Zahl an mehreren Stellen hätten und sie aktualisieren müssten, müssten wir außerdem jede Instanz davon aktualisieren. Der gesamte Vorgang ist jedoch viel einfacher, wenn Sie die Zahlen richtig benannten Variablen zuweisen.

Im folgenden Beispiel haben wir eine Funktion, die einen Wert namens Ergebnis berechnet und ihn mit 0,6 multipliziert. Wir können anhand des Codes nicht genau wissen, was der Code bedeutet

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

Zusammenfassung

Das Hinzufügen von Dokumentation zu unserem Code durch Kommentare und Dokumentzeichenfolgen kann viel dazu beitragen, uns selbst und anderen zu helfen, zu verstehen, was der Code tut. Tatsächlich mag es sich zunächst wie eine lästige Pflicht anfühlen, aber mit der Verwendung von Werkzeugen und regelmäßiger Übung kann es für Sie zur zweiten Natur werden.

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!