Declarar correctamente la codificación del código fuente de Python

PEP 263 describe la práctica estándar para declarar la codificación del código fuente de Python. Si bien la convención típica implica el uso de "# -- codificación: --", no es raro encontrar variaciones que usan "# -- codificación: --".

Entonces, ¿cuál es la forma correcta para codificar la declaración?

Según la documentación de Python, un comentario que coincide con la siguiente expresión regular en la primera o segunda línea del script de Python se procesa como una declaración de codificación:

coding[=:]\s*([-\w.] )

Formularios recomendados:

Se proporcionan dos formularios recomendados:

• # -*- codificación: -*-
• # vim:fileencoding=

El primero es reconocido por GNU Emacs, mientras que el segundo es específico de Vim.

Consideraciones de compatibilidad:

Para obtener la máxima compatibilidad, es mejor ceñirse al prefijo "codificación" sin ningún texto adicional. Sin embargo, es importante tener en cuenta que un software de edición específico puede requerir o aceptar diferentes formatos.

Por ejemplo, GNU Emacs reconoce el formato de codificación de fábrica, pero Vim no. Por lo tanto, es esencial utilizar un formulario que sea compatible tanto con Python como con el entorno de edición elegido.