Format d'en-tête commun en Python
Un en-tête est un bloc de commentaires en haut du code, qui comprend le nom du fichier, l’auteur, la date et quelques autres détails du fichier et du contenu de ce fichier. Les modules intégrés importés et les importations de tiers suivent cela. Ce format peut différer d’un programmeur à l’autre.
Dans cet article de didacticiel, nous présenterons le format d’en-tête le plus courant pour les fichiers source Python.
Le code suivant montre un format d’en-tête commun utilisé dans Python.
#!/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
La première ligne, (#!/usr/bin/env python3 ), facilite l’exécution du fichier en tant que script en invoquant implicitement l’interpréteur car cette ligne est un script exécutable. Il informe également l’utilisateur que le code est écrit pour un format particulier, Python3 dans ce cas.
La ligne ( -*- coding: utf-8 -*-) est utilisée pour l’encodage. C’est le processus de conversion des données d’une forme à une autre. UTF signifie Unicode Transformation Format, et 8 indique que des valeurs 8 bits sont utilisées dans le processus d’encodage. Il existe plusieurs types d’encodages (UTF-16, UTF-34, etc.), mais en python 3, le jeu de caractères par défaut est UTF-8.
La troisième ligne contient les détails sur l’auteur, la date, le numéro de version, les crédits, l’e-mail, le statut, la licence, les droits d’auteur, etc.
La quatrième ligne est une docstring notée (""" """), qui documente le module et dans quel but il a été construit. C’est un moyen pratique d’associer toutes les fonctions, classes et méthodes. Il est uniquement spécifié pour décrire un code particulier.
La ligne suivante contient les importations des modules intégrés utilisés dans le code, par exemple, le module os, le module sys, le module math, etc.
Toutes les importations de modules tiers, par exemple NumPy, Matplotlib, etc., sont spécifiées dans la dernière ligne.