Formato de encabezado común en Python
Un encabezado es un bloque de comentarios en la parte superior del código, que incluye el nombre del archivo, el autor, la fecha y algunos otros detalles del archivo y el contenido de ese archivo. Los módulos incorporados importados y las importaciones de terceros siguen esto. Este formato puede diferir de un programador a otro.
En este artículo del tutorial, presentaremos el formato de encabezado más común para los archivos fuente de Python.
El siguiente código muestra un formato de encabezado común utilizado en 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 primera línea, (#!/usr/bin/env python3 ), facilita la ejecución del archivo como un script invocando implícitamente al intérprete ya que esta línea es un script ejecutable. También informa al usuario que el código está escrito para un formato particular, Python3 en este caso.
La línea ( -*- coding: utf-8 -*-) se utiliza para la codificación. Es el proceso de convertir datos de una forma a otra. UTF son las siglas de Unicode Transformation Format, y 8 denota que se están utilizando valores de 8 bits en el proceso de codificación. Hay varios tipos de codificaciones (UTF-16, UTF-34, etc.), pero en Python 3, el conjunto de caracteres predeterminado es UTF-8.
La tercera línea contiene los detalles sobre el autor, fecha, número de versión, créditos, correo electrónico, estado, licencia, derechos de autor, etc.
La cuarta línea es una cadena de documentación indicada por (""" """), que documenta el módulo y para qué se ha construido. Es una forma conveniente de asociarse con todas las funciones, clases y métodos. Se especifica de forma única para describir un código en particular.
La siguiente línea contiene las importaciones de módulos incorporados utilizados en el código, por ejemplo, Módulo os, Módulo sys, Módulo math, etc.
Todas las importaciones de módulos de terceros, por ejemplo, NumPy, Matplotlib, etc., se especifican en la última línea.