python文件头注释及添加文件头模版

一、python文件头注释

主要是以下两行：

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

第一行是选定编译器的版本，一般我们都通过以下方式运行python代码：

python 1003.py

有了第一句之后，python文件就可以和shell脚本一样，直接执行：

$ chmod +x 1003.py
$ ./1003.py
hello world

如果你是通过python3 1003.py运行代码，这一句就得改成#!/usr/bin/env python3。

第二句告诉python解释器，这个文件是以UTF-8方式编码存储的，主要是为了避免代码中出现非ASCII字符（中文和日文）时，程序报错。如下：

$ cat 1003.py
#!/usr/bin/env python
print("你好")
$ ./1003.py 
  File "./1003.py", line 2
SyntaxError: Non-ASCII character '\xe4' in file ./1003.py on line 2, but no encoding declared; see http://python.org/dev/peps/pep-0263/ for details

#指定编码格式后，代码正常运行
$ cat 1003.py
#!/usr/bin/env python
# -*-coding:utf-8 -*-
print("你好")
$ ./1003.py 
你好

二、vscode添加python头模版

既然如此有用，能不能每次写python代码的时候自动添加呢？
因为我是用vscode写python代码，主要讲下vscode如何实现。

1、python头文件设置

之后选择python后会打开python.json，添加以下内容即可：

"HEADER":{
    "prefix": "header",
    "body": [
    "#!/usr/bin/env python",
    "# -*-coding:utf-8 -*-", 
    "'''",
    "@File    :   $TM_FILENAME",
    "@Time    :   $CURRENT_YEAR/$CURRENT_MONTH/$CURRENT_DATE $CURRENT_HOUR:$CURRENT_MINUTE:$CURRENT_SECOND",
    "@Author  :   Schiller Xu ",
    "@Version :   1.0",
    "@Contact :   schillerxu@qq.com",
    "@License :   (C)Copyright 2020-2021, SchillerXu",
    "@Desc    :   None",
    
    "'''",
    "$0"
],
}

可以根据自己需要改写。

2、如何使用

只要在py文件最前面输入header回车就会自动生成文件头，如下：

代码片段主要参考了追蜗牛的coder一篇博客，文末有链接，非常感谢！

三、参考资料

Python文件头注释的含义
vscode添加python文件头模板