显式声明编码可避免跨平台读取源码时出现SyntaxError或乱码;因部分编辑器(如旧版Windows记事本)可能保存为GBK,而Python解释器若未识别BOM或声明,会按系统默认编码解析,导致错误。

Python文件默认使用UTF-8编码,但显式声明编码可避免跨平台(Windows/Linux/macOS)读取源码时出现SyntaxError或乱码,尤其涉及中文注释、字符串字面量或非ASCII字符时。
为什么需要显式声明编码?
Python 3 默认以UTF-8读取源文件,但部分编辑器(如旧版Windows记事本、某些IDE配置)可能保存为GBK/GB2312;Python解释器若未识别到BOM或编码声明,会按系统默认编码尝试解析,导致语法错误。Linux/macOS通常无BOM,更依赖# -*- coding: utf-8 -*-这类声明。
标准声明方式(推荐)
在.py文件**第一行或第二行**添加编码声明(PEP 263规范),格式严格:
- 必须是前两行之一(空行允许,注释行也可,但不能是第三行以后)
- 必须匹配正则
^[ \t\v]*#.*?coding[=:][ \t]*([-_.a-zA-Z0-9]+) - 推荐写法(兼容性最好):# -*- coding: utf-8 -*-
- 其他合法写法:# coding=utf-8、# vim: set fileencoding=utf-8 :
实际开发中的关键注意点
仅声明编码不足以解决全部问题,还需配合以下实践:
立即学习“Python免费学习笔记(深入)”;
- 编辑器统一设为UTF-8无BOM:VS Code、PyCharm默认符合;Windows记事本务必另存为“UTF-8”(非“UTF-8-BOM”)
- 避免混合编码:同一项目所有.py文件应统一用UTF-8,不混用GBK等
-
字符串处理需区分字节与文本:读写外部文件(如CSV、TXT)时,显式指定
encoding='utf-8',不要依赖系统默认 -
Shebang行后仍可加编码声明:Linux/macOS脚本首行
#!/usr/bin/env python3后,第二行即可写# -*- coding: utf-8 -*-
验证是否生效的小技巧
在含中文的.py文件中加入测试代码,运行不报错即说明编码声明被正确识别:
-
print("你好,世界")—— 源码含中文字符串 -
# 这是一段中文注释—— 中文注释不引发SyntaxError - 用
python -m py_compile xxx.py编译,成功即通过基础校验










