Qual é o formato de cabeçalho comum dos arquivos Python?

Eu sou fortemente a favor dos cabeçalhos mínimos dos ficheiros, ou seja, apenas:

• a hashbang ({[[0]} linha) se este for um programa executável
• docstring do Módulo
• Importações, agrupadas como descrito na resposta da voyager.

Se tiver declarações de exoneração de responsabilidade legais ou informações de licença, vai para um ficheiro separado. Ele não precisa infectar todos os arquivos de código fonte. Sua os direitos de autor devem fazer parte disto. As pessoas devem ser capazes de encontrá-lo em seu arquivo LICENSE, Não código fonte Aleatório.

Metadados como a autoria e as datas já são mantidos pelo seu controlo de origem. Não há necessidade de adicionar uma versão menos detalhada, errônea e desactualizada da mesma informação no próprio arquivo.

Ver também PEP 263 Se estiver a utilizar um conjunto de caracteres não ascii

Resumo

Este PEP propõe introduzir uma sintaxe para declarar a codificação de um ficheiro de código Python. A informação de codificação é então usada pelo Analisador Python para interpretar o ficheiro com a codificação indicada. Mais notavelmente, isso aumenta a interpretação de literais Unicode em o código fonte e torna possível escrever literais Unicode = = ligações externas = = UTF-8 directly in an Unicode aware editor.

Problema

Em Python 2. 1, os literais Unicode só podem ser escritos usando a Latin - 1 based encoding "unicode-escape". Isto faz com que o ambiente de programação pouco amigável para os usuários Python que vivem e trabalhar em locais não-latinos - 1, como muitos dos asiáticos pais. Os programadores podem escrever as suas cadeias de 8 bits usando o codificação favorita, mas está ligada à codificação "unicode-escape" para Unicode literals.

Solução Proposta

Proponho que a codificação do código-fonte Python seja visível e alterável numa base de ficheiro por fonte, usando um comentário especial no topo do arquivo para declarar a codificação.

Para tornar o Python ciente desta Declaração de codificação, um número de são necessárias alterações de conceitos no que se refere ao tratamento de Dados do código-fonte Python.

Definir a codificação

Python será por omissão o ASCII como codificação-padrão se nenhuma outra são dadas dicas de codificação.

Para definir uma codificação de código-fonte, um comentário mágico deve ser colocado nos ficheiros de código como primeiro ou segundo linha no arquivo, como:

      # coding=<encoding name>

Ou (usando formatos reconhecidos pelos editores populares)

      #!/usr/bin/python
      # -*- coding: <encoding name> -*-

Ou

      #!/usr/bin/python
      # vim: set fileencoding=<encoding name> :

...

As respostas acima estão realmente completas, mas se quiser um cabeçalho rápido e sujo para o copy'n paste, use isto:

#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""Module documentation goes here
   and here
   and ...
"""

• a primeira linha é para os utilizadores do nix. Ele irá escolher o interpretador Python no caminho do usuário, então irá escolher automaticamente o interpretador preferido do Usuário.
• o segundo é a codificação do ficheiro. Hoje em dia todos os arquivos devem ter uma codificação associada. UTF-8 vai funcionar em todo o lado. Apenas projetos legados usariam outros codificacao.
• e uma documentação muito simples. Pode encher várias linhas.

Ver também: https://www.python.org/dev/peps/pep-0263/