Python的编码注释# -*- coding:utf-8 -*-

2019独角兽企业重金招聘Python工程师标准>>>

如果要在python2的py文件里面写中文，则必须要添加一行声明文件编码的注释，否则python2会默认使用ASCII编码。

# -*- coding:utf-8 -*-

问题就来了，为什么要如此声明？
首先请参考python的 PEP
概要如下

1. 必须将编码注释放在第一行或者第二行

2. 可选格式有

   # coding=<encoding name> # -- coding: <encoding name> -- # vim: set fileencoding=<encoding name> :

但是再往下看，发现其实只要注释里面有coding 和对应的编码就可以了，例如

# vim: set fileencoding=<encoding name> :  

所以搞了半天对最标准的做法也有点糊涂了。
后来想了想，看了下VIM中对python的语法高亮文件，里面把如下的正则表达式确定为编码声明

\%^.*\(\n.*\)\?#.*coding[:=]\s*[0-9A-Za-z-_.]\+.*$  

对于这个正则有些有点看不懂，但是大致如下必须有coding:[编码]或者coding=[编码]才行，这个应该可以视作为标准的声明方式吧。
但是为什么通常这种方式呢？

# -*- coding:utf-8 -*-  

答案在PEP-0263里面有所提及，那就是Emacs等编辑器使用这种方式进行编码声明。 话说PEP里面很多东西都是很值得参考的毕竟可以知道为什么程序这样设计。

相关参考

1. PEP-0263
2. vim语法文件编写总结
3. # -- coding: UTF-8 -- 这是个注释吗？

转载于:https://my.oschina.net/lujian863/blog/205967