¿Cuál es el formato de encabezado común de los archivos Python?

Estoy fuertemente a favor de los encabezados de archivo mínimos, con lo que quiero decir solo:

• La línea hashbang (#!) si se trata de un script ejecutable
• Módulo docstring
• Importaciones, agrupadas como se describe en voyager's respuesta.

Todo lo demás es una pérdida de tiempo, espacio visual, y es activamente engañoso.

Si tiene renuncias legales o información de licencia, va a un archivo separado. No necesita infectar todos los archivos de código fuente. Sus derechos de autor debería ser parte de esto. La gente debería poder encontrarlo en su archivo LICENSE, no en el código fuente aleatorio.

Los metadatos, como la autoría y las fechas, ya están mantenidos por su control de código fuente. No es necesario agregar una versión menos detallada, errónea y desactualizada de la misma información en el propio archivo.

No creo que haya ningún otro dato que todo el mundo necesite poner en todos sus archivos fuente. Usted puede tener algún requisito particular para hacerlo, pero tales cosas se aplican, por definición, solo para ti. No tienen lugar en "encabezados generales recomendados para todos".

También ver PEP 263 si está utilizando un conjunto de caracteres no ascii

Resumen

Este PEP propone introducir una sintaxis para declarar la codificación de un archivo fuente de Python. La información de codificación es utilizada por el Python parser para interpretar el archivo usando la codificación dada. Mas notablemente, esto mejora la interpretación de los literales Unicode en el código fuente y permite escribir literales Unicode usando, por ejemplo, UTF-8 directamente en un editor compatible con Unicode.

Problema

En Python 2.1, los literales Unicode solo se pueden escribir usando el Latin-1 based encoding "unicode-escape". Esto hace que el entorno de programación bastante hostil para los usuarios de Python que viven y trabajar en lugares no latinos-1 como muchos de los asiáticos pais. Los programadores pueden escribir sus cadenas de 8 bits utilizando el codificación favorita, pero están vinculados a la codificación" unicode-escape" para Unicode literal.

Solución propuesta

Propongo que la codificación del código fuente de Python sea visible y se puede cambiar por archivo fuente mediante el uso de un comentario especial en la parte superior del archivo para declarar la codificación.

Para hacer que Python sea consciente de esta declaración de codificación, un número de los cambios de concepto son necesarios con respecto al manejo de Datos del código fuente de Python.

Definiendo la codificación

Python por defecto a ASCII como codificación estándar si no hay otro se dan sugerencias de codificación.

Para definir una codificación de código fuente, un comentario mágico debe ser colocado en los archivos de origen ya sea como primero o segundo línea en el archivo, como:

      # coding=<encoding name>

O (usando formatos reconocidos por editores populares)

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

O

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

...

Las respuestas anteriores son realmente completas, pero si quieres un encabezado rápido y sucio para copiar y pegar, usa esto:

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

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

Por qué esto es bueno:

• La primera línea es para usuarios *nix. Elegirá el intérprete de Python en la ruta del usuario, por lo que elegirá automáticamente el intérprete preferido por el usuario.
• El segundo es la codificación del archivo. Hoy en día cada archivo debe tener una codificación asociada. UTF-8 funcionará en todas partes. Solo los proyectos heredados usarían otros codificación.
• Y una documentación muy sencilla. Puede llenar varias líneas.

Véase también: https://www.python.org/dev/peps/pep-0263 /

Si solo escribes una clase en cada archivo, ni siquiera necesitas la documentación (iría dentro de la clase doc).