Formato de cabeçalho comum em Python

Um cabeçalho é um bloco de comentários na parte superior do código, que inclui o nome do arquivo, autor, data e alguns outros detalhes do arquivo e o conteúdo desse arquivo. Seguem-se módulos embutidos importados e importações de terceiros. Este formato pode variar de programador para programador.

Neste artigo tutorial, apresentaremos o formato de cabeçalho mais comum para arquivos de origem Python.

O código a seguir mostra um formato de cabeçalho comum usado em 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

A primeira linha, (#!/usr/bin/env python3 ), torna mais fácil executar o arquivo como um script invocando o interpretador implicitamente, pois esta linha é um script executável. Ele também informa ao usuário que o código foi escrito para um formato específico, Python3 neste caso.

A linha ( -*- coding: utf-8 -*-) é usada para codificação. É o processo de conversão de dados de um formulário para outro. UTF significa Unicode Transformation Format e 8 denota que valores de 8 bits estão sendo usados ​​no processo de codificação. Existem vários tipos de codificações (UTF-16, UTF-34, etc.), mas em python 3, o conjunto de caracteres padrão é UTF-8.

A terceira linha contém os detalhes sobre o autor, data, número da versão, créditos, e-mail, status, licença, direitos autorais, etc.

A quarta linha é uma docstring denotada por (""" """), que documenta o módulo e para que propósito ele foi construído. É uma maneira conveniente de se associar a todas as funções, classes e métodos. Ele é especificado exclusivamente para descrever um código específico.

A linha a seguir contém as importações de módulos integrados usados ​​no código, por exemplo, Módulo os, Módulo sys, Módulo math, etc.

Todas as importações de módulos de terceiros, por exemplo, NumPy, Matplotlib, etc., são especificadas na linha final.