Gemeinsames Header-Format in Python

Ein Header ist ein Block von Kommentaren am Anfang des Codes, der den Dateinamen, den Autor, das Datum und einige andere Details der Datei und des Inhalts dieser Datei enthält. Es folgen importierte eingebaute Module und Importe von Drittanbietern. Dieses Format kann von Programmierer zu Programmierer unterschiedlich sein.

In diesem Tutorial-Artikel stellen wir das gängigste Header-Format für Python-Quelldateien vor.

Der folgende Code zeigt ein gängiges Headerformat, das in Python verwendet wird.

#!/usr/bin/env python3  Line 1
# -*- coding: utf-8 -*- Line 2
# ----------------------------------------------------------------------------
# Created By  : name_of_the_creator   Line 3
# Created Date: date/month/time ..etc
# version ='1.0'
# ---------------------------------------------------------------------------
""" Details about the module and for what purpose it was built for"""  # Line 4
# ---------------------------------------------------------------------------
# Imports Line 5
# ---------------------------------------------------------------------------
from ... import ...  # Line 6

Die erste Zeile, (#!/usr/bin/env python3 ), erleichtert die Ausführung der Datei als Skript, indem der Interpreter implizit aufgerufen wird, da es sich bei dieser Zeile um ein ausführbares Skript handelt. Es informiert den Benutzer auch darüber, dass der Code für ein bestimmtes Format geschrieben wurde, in diesem Fall für Python3.

Zur Kodierung wird die Zeile ( -*- coding: utf-8 -*-) verwendet. Es ist der Prozess der Konvertierung von Daten von einem Formular in ein anderes. UTF steht für Unicode Transformation Format, und 8 bedeutet, dass 8-Bit-Werte beim Codierungsprozess verwendet werden. Es gibt mehrere Arten von Codierungen (UTF-16, UTF-34 usw.), aber in Python 3 ist der Standardzeichensatz UTF-8.

Die dritte Zeile enthält die Angaben zu Autor, Datum, Versionsnummer, Credits, E-Mail, Status, Lizenz, Copyrights usw.

Die vierte Zeile ist ein mit (""" """) bezeichneter Docstring, der das Modul dokumentiert und zu welchem ​​Zweck es gebaut wurde. Es ist eine bequeme Möglichkeit, mit allen Funktionen, Klassen und Methoden zu assoziieren. Es ist eindeutig spezifiziert, um einen bestimmten Code zu beschreiben.

Die folgende Zeile enthält die Importe von eingebauten Modulen, die im Code verwendet werden, zum Beispiel os-Modul, sys-Modul, math-Modul usw.

In der letzten Zeile werden alle Importe von Fremdmodulen, zum Beispiel NumPy, Matplotlib usw., angegeben.