定义 Python 源代码编码的正确方法-IT科技

定义 Python 源代码编码的正确方法

2025-01-08 08:50:00

admin

原创

203

摘要：问题描述：PEP 263定义了如何声明 Python 源代码编码。通常，Python 文件的前两行应该以以下内容开头：#!/usr/bin/python # -*- coding: <encoding name> -*- 但是我看到很多文件以以下内容开头：#!/usr/bin/python #...

问题描述：

PEP 263定义了如何声明 Python 源代码编码。通常，Python 文件的前两行应该以以下内容开头：

#!/usr/bin/python
# -*- coding: <encoding name> -*-

但是我看到很多文件以以下内容开头：

#!/usr/bin/python
# -*- encoding: <encoding name> -*-

即，它说的encoding是而不是coding。

文件编码该如何声明？

尝试在 Python 脚本中使用非 ASCII 文本时，请使用“SyntaxError：非 ASCII 字符 ...”或“SyntaxError：以 ... 开头的非 UTF-8 代码”来关闭有关因缺少或错误编码声明而导致的语法错误的重复问题。另一方面，这个问题是关于如何编写声明以及是否有必要的问题的典型问题。

解决方案 1：

在此处查看文档：

“如果 Python 脚本第一行或第二行的注释与正则表达式匹配coding[=:]s*([-w.]+)，则该注释将被视为编码声明”

“此表达式的推荐形式为

# -*- coding: <encoding-name> -*-

GNU Emacs 也认可这一点，并且

# vim:fileencoding=<encoding-name>

它被 Bram Moolenaar 的 VIM 所识别。”

因此，您可以在“编码”部分之前放置任何内容，但如果您想要 100% 兼容 python-docs-recommendation，请坚持使用“编码”（没有前缀）。

更具体地说，您需要使用 Python和您使用的特定编辑软件所识别的任何内容（如果它需要/接受任何东西）。例如，codingGNU Emacs 可以识别（开箱即用）该表单，但 Vim 无法识别（是的，如果没有一个普遍的协议，这本质上就是一场地盘之争）。

解决方案 2：

PEP 263：

第一行或第二行必须匹配正则表达式“coding[:=]\s*([-\w.]+)”

因此，“en encoding: UTF-8 ”匹配。

PEP 提供了一些示例：

#!/usr/bin/python
# vim: set fileencoding=<encoding name> :

# This Python file uses the following encoding: utf-8
import os, sys

解决方案 3：

只需将下面的语句复制粘贴到程序顶部即可解决字符编码问题

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

解决方案 4：

截至今日——2018 年 6 月

PEP 263本身提到了它所遵循的正则表达式：

要定义源代码编码，必须将魔术注释放入源文件中，作为文件的第一行或第二行，例如：
# coding=<encoding name>
或（使用流行编辑器识别的格式）：
#!/usr/bin/python
# -*- coding: <encoding name> -*-
或者：
#!/usr/bin/python
# vim: set fileencoding=<encoding name> : 
更准确地说，第一行或第二行必须与以下正则表达式匹配：
^[     ]*#.*?coding[:=][     ]*([-_.a-zA-Z0-9]+)

因此，正如其他答案已经总结的那样，它会coding与任何前缀匹配，但如果你想尽可能地符合 PEP 标准（尽管据我所知，使用encoding而coding不是不会以任何方式违反 PEP 263） - 坚持使用 'plain' coding，不带前缀。