Правильное объявление кодировки исходного кода Python

PEP 263 описывает стандартную практику объявления кодировки исходного кода Python. Хотя обычное соглашение предполагает использование «# -- coding: --», нередко можно встретить варианты, в которых используется «# -- coding: --".

Итак, какова правильная форма объявления кодировки?

Согласно документации Python, комментарий, соответствующий следующему регулярному выражению в первой или второй строке скрипта Python, обрабатывается как объявление кодировки:

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

Рекомендуемые формы:

Предоставлены две рекомендуемые формы:

• # -*- кодирование: -*-
• # vim:fileencoding=

Первый распознается GNU Emacs, а второй специфичен для Vim.

Соображения по совместимости:

Для максимальной совместимости лучше придерживаться Префикс «кодирование» без дополнительного текста. Однако важно отметить, что конкретное программное обеспечение для редактирования может требовать или принимать разные форматы.

Например, GNU Emacs «из коробки» распознает форму кодирования, а Vim — нет. Поэтому очень важно использовать форму, совместимую как с Python, так и с выбранной вами средой редактирования.