Formato di intestazione comune in Python

Un’intestazione è un blocco di commenti nella parte superiore del codice, che include il nome del file, l’autore, la data e alcuni altri dettagli del file e il contenuto di quel file. Seguono i moduli incorporati importati e le importazioni di terze parti. Questo formato può variare da programmatore a programmatore.

In questo articolo del tutorial, introdurremo il formato di intestazione più comune per i file sorgente Python.

Il codice seguente mostra un formato di intestazione comune utilizzato in 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 prima riga, (#!/usr/bin/env python3 ), semplifica l’esecuzione del file come script invocando implicitamente l’interprete poiché questa riga è uno script eseguibile. Inoltre informa l’utente che il codice è scritto per un formato particolare, Python3 in questo caso.

La riga ( -*- coding: utf-8 -*-) è usata per la codifica. È il processo di conversione dei dati da un modulo all’altro. UTF sta per Unicode Transformation Format e 8 indica che vengono utilizzati valori a 8 bit nel processo di codifica. Esistono più tipi di codifiche (UTF-16, UTF-34, ecc.), ma in Python 3, il set di caratteri predefinito è UTF-8.

La terza riga contiene i dettagli sull’autore, la data, il numero di versione, i crediti, l’e-mail, lo stato, la licenza, i diritti d’autore, ecc.

La quarta riga è una docstring indicata con (""" """), che documenta il modulo e per quale scopo è stato costruito. È un modo conveniente per associarsi a tutte le funzioni, classi e metodi. È specificato in modo univoco per descrivere un codice particolare.

La riga seguente contiene le importazioni dei moduli incorporati utilizzati nel codice, ad esempio, modulo os, modulo sys, modulo math, ecc.

Tutte le importazioni di moduli di terze parti, ad esempio NumPy, Matplotlib, ecc., sono specificate nella riga finale.