Ansible 和 Python 3

ansible-core 代码运行 Python 3（有关特定版本，请查看控制节点要求）。ansible-core 和 Ansible 集合的贡献者应该了解本文档中的提示，以便他们可以编写在与其余 Ansible 相同的 Python 版本上运行的代码。

我们确实有一些考虑因素，具体取决于 Ansible 代码的类型

控制节点上的代码 - 在调用 /usr/bin/ansible 的机器上运行的代码，只需要支持控制节点的 Python 版本。
模块 - Ansible 传输到并在托管机器上调用的代码。模块需要支持“托管节点”Python 版本，但有一些例外。
共享 module_utils 代码 - 模块用来执行任务的通用代码，有时控制节点上的代码也会使用。共享的 module_utils 代码需要支持与模块相同的 Python 版本范围。

但是，这三种类型的代码不使用相同的字符串策略。如果您正在开发模块或一些 module_utils 代码，请务必仔细阅读有关字符串策略的部分。

Python 3.x 和 Python 2.x 的最低版本 

有关支持的特定版本，请参阅控制节点要求和托管节点要求。

您的自定义模块可以支持您想要的任何版本的 Python（或其他语言），但以上是为 Ansible 项目贡献的代码的要求。

开发支持 Python 2 和 Python 3 的 Ansible 代码 

了解编写同时支持 Python 2 和 Python 3 的代码的最佳起点是 Lennart Regebro 的书：《Porting to Python 3》。这本书描述了移植到 Python 3 的几种策略。我们使用的是从单个代码库支持 Python 2 和 Python 3

了解 Python 2 和 Python 3 中的字符串 

Python 2 和 Python 3 处理字符串的方式不同，因此当您编写支持 Python 3 的代码时，必须决定使用哪种字符串模型。字符串可以是字节数组（如 C 中），也可以是文本数组。文本是我们认为的字母、数字、数字、其他可打印的符号以及少量不可打印的“符号”（控制代码）。

在 Python 2 中，这两种类型（str 用于字节，unicode 用于文本）经常互换使用。在仅处理 ASCII 字符时，字符串可以组合、比较并自动从一种类型转换为另一种类型。当引入非 ASCII 字符时，Python 2 会开始引发异常，因为它不知道非 ASCII 字符应采用什么编码。

Python 3 通过更严格地分隔字节 (bytes) 和文本 (str) 来更改此行为。当尝试组合和比较这两种类型时，Python 3 会引发异常。程序员必须显式地从一种类型转换为另一种类型才能混合来自每种类型的值。

在 Python 3 中，当代码不适当地混合字节和文本类型时，程序员会立即意识到，而在 Python 2 中，混合这些类型的代码可能会一直工作，直到用户通过输入非 ASCII 输入导致异常。Python 3 迫使程序员主动定义在其程序中处理字符串的策略，以便他们不会无意中混合文本和字节字符串。

Ansible 在控制节点上的代码中、在 :ref: 模块 <module_string_strategy> 和 module_utils 代码中使用不同的字符串处理策略。

控制节点字符串策略：Unicode 三明治 

直到最近，ansible-core 都支持 Python 2.x 并遵循此策略，称为 Unicode 三明治（以 Python 2 的 unicode 文本类型命名）。对于 Unicode 三明治，我们知道在代码和外部世界（例如，文件和网络 IO、环境变量和一些库调用）的边界上，我们将收到字节。我们需要将这些字节转换为文本，并在我们代码的内部部分中使用它。当我们必须将这些字符串发送回外部世界时，我们首先将文本转换回字节。为了可视化这一点，请想象一个“三明治”，它由顶层和底层的字节、中间的转换层以及中心的所有文本类型组成。

出于兼容性考虑，您会看到我们开发的一些自定义函数（to_text/to_bytes/to_native）。虽然 Python 2 不再是问题，但我们仍将继续使用它们，因为它们适用于处理 Unicode 时遇到的其他问题。

虽然我们大部分时间不再使用它，但下面的文档对于那些仍然需要同时支持 Python 2 和 3 的模块的开发人员仍然很有用。

Unicode 三明治常见边界：在控制节点代码中将字节转换为文本的地方 

这是使用 Unicode 三明治字符串策略时，我们必须在字节之间进行转换的部分列表。它并不详尽，但可以让您了解需要注意的问题。

读写文件 

在 Python 2 中，从文件中读取会产生字节。在 Python 3 中，它可以产生文本。为了使代码可以移植到两者，我们不使用 Python 3 产生文本的能力，而是自己显式地进行转换。例如

from ansible.module_utils.common.text.converters import to_text

with open('filename-with-utf8-data.txt', 'rb') as my_file:
    b_data = my_file.read()
    try:
        data = to_text(b_data, errors='surrogate_or_strict')
    except UnicodeError:
        # Handle the exception gracefully -- usually by displaying a good
        # user-centric error message that can be traced back to this piece
        # of code.
        pass

注意

Ansible 的许多部分都假设所有编码文本都是 UTF-8。在某些时候，如果需要其他编码，我们可能会更改它，但现在可以安全地假设字节是 UTF-8。

写入文件是相反的过程

from ansible.module_utils.common.text.converters import to_bytes

with open('filename.txt', 'wb') as my_file:
    my_file.write(to_bytes(some_text_string))

请注意，我们不必在此处捕获 UnicodeError，因为我们正在转换为 UTF-8，并且 Python 中的所有文本字符串都可以转换回 UTF-8。

文件系统交互 

处理文件名通常涉及回退到字节，因为在类 UNIX 系统上，文件名是字节。在 Python 2 上，如果我们向这些函数传递文本字符串，则文本字符串将在函数内部转换为字节字符串，如果存在非 ASCII 字符，则会发生回溯。在 Python 3 中，只有当文本字符串无法在当前区域设置中解码时才会发生回溯，但显式声明并拥有可在两个版本上工作的代码仍然是很好的做法

import os.path

from ansible.module_utils.common.text.converters import to_bytes

filename = u'/var/tmp/くらとみ.txt'
f = open(to_bytes(filename), 'wb')
mtime = os.path.getmtime(to_bytes(filename))
b_filename = os.path.expandvars(to_bytes(filename))
if os.path.exists(to_bytes(filename)):
    pass

当您仅将文件名作为字符串进行操作，而不与文件系统（或与文件系统对话的 C 库）交互时，通常可以避免转换为字节

import os.path

os.path.join(u'/var/tmp/café', u'くらとみ')
os.path.split(u'/var/tmp/café/くらとみ')

另一方面，如果代码需要操作文件名并且还需要与文件系统交互，则最好立即转换为字节并以字节形式进行操作。

警告

确保传递给函数的所有变量类型相同。如果您正在使用 os.path.join() 之类的东西，它会接受多个字符串并将它们组合使用，则需要确保所有类型都相同（全部为字节或全部为文本）。混合字节和文本将导致回溯。

与其他程序交互 

与其他程序交互会通过操作系统和 C 库，并对 UNIX 内核定义的事物进行操作。这些接口都是面向字节的，因此 Python 接口也是面向字节的。在 Python 2 和 Python 3 上，都应将字节字符串传递给 Python 的子进程库，并且应该从中返回字节字符串。

在 Ansible 的控制节点代码中，我们与其他程序交互的主要场所之一是连接插件的 exec_command 方法。这些方法将它们在要执行的命令中接收到的任何文本字符串（以及命令的参数）转换为字节，并返回 stdout 和 stderr 作为字节字符串。更高级别的函数（如操作插件的 _low_level_execute_command）会将输出转换为文本字符串。

模块字符串策略：原生字符串 

在模块中，我们使用一种称为“原生字符串”的策略。这使得维护 Ansible 如此多模块的社区成员更容易，而不会通过强制要求模块内的所有字符串都是文本并在边界处在文本和字节之间进行转换来破坏向后兼容性。

原生字符串是指 Python 在您指定裸字符串文字时使用的类型

"This is a native string"

在 Python 2 中，这些是字节字符串。在 Python 3 中，这些是文本字符串。模块应进行编码以在 Python 2 上期望字节，在 Python 3 上期望文本。

Module_utils 字符串策略：混合 

在 module_utils 代码中，我们使用混合字符串策略。尽管 Ansible 的 module_utils 代码与模块代码非常相似，但它的某些部分也由控制节点使用。因此，它需要与模块和控制节点的假设兼容，尤其是字符串策略。module_utils 代码尝试接受原生字符串作为其函数的输入，并发出原生字符串作为其输出。

在 module_utils 代码中

函数必须接受字符串参数作为文本字符串或字节字符串。
函数可能会返回与给定字符串类型相同的字符串，或者返回在其运行的 Python 版本中使用的原生字符串类型。
返回字符串的函数必须记录它们是返回与给定字符串类型相同的字符串还是原生字符串。

因此，模块实用程序函数通常具有很强的防御性。它们在函数开头将其字符串参数转换为文本（使用 ansible.module_utils.common.text.converters.to_text），完成它们的工作，然后将返回值转换为原生字符串类型（使用 ansible.module_utils.common.text.converters.to_native）或返回到其参数接收的字符串类型。

Python 2/Python 3 兼容性的技巧、窍门和惯用语 

使用向前兼容的样板 

在所有 python 文件的顶部使用以下样板代码，使某些构造在 Python 2 和 Python 3 上的行为方式相同

# Make coding more python3-ish
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type

__metaclass__ = type 使文件中定义的所有类都成为新式类，而无需显式继承自 object。

__future__ 导入执行以下操作

absolute_import：: 使导入在 sys.path 中查找要导入的模块，跳过进行导入的模块所在的目录。如果代码要使用进行导入的模块所在的目录，则可以使用新的点表示法来执行此操作。
division：: 使整数除法始终返回浮点数。如果需要查找商，请使用 x // y 而不是 x / y。
print_function：: 将 print 从关键字更改为函数。

另请参阅

用 `b_` 前缀字节字符串 

由于混合文本和字节类型会导致回溯，因此我们希望明确哪些变量保存文本，哪些变量保存字节。我们通过为任何保存字节的变量添加 b_ 前缀来做到这一点。例如

filename = u'/var/tmp/café.txt'
b_filename = to_bytes(filename)
with open(b_filename) as f:
    data = f.read()

我们不为文本字符串添加前缀，因为我们仅在边界处操作字节字符串，因此需要字节的变量比文本少。

导入 Ansible 捆绑的 Python `six` 库 

第三方 Python six 库的存在是为了帮助项目创建可在 Python 2 和 Python 3 上运行的代码。Ansible 在 module_utils 中包含该库的一个版本，以便其他模块可以使用它，而无需在远程系统上安装它。要使用它，请像这样导入它

from ansible.module_utils import six

注意

Ansible 也可以使用 six 的系统副本

如果系统自带的 six 版本比 Ansible 打包的版本新，Ansible 将会使用系统自带的 six 版本。

使用 `as` 处理异常 

为了使代码能在 Python 2.6+ 和 Python 3 上运行，请使用新的异常捕获语法，该语法使用 as 关键字。

try:
    a = 2/0
except ValueError as e:
    module.fail_json(msg="Tried to divide by zero: %s" % e)

不要使用以下语法，因为它会在所有 Python 3 版本上失败。

try:
    a = 2/0
except ValueError, e:
    module.fail_json(msg="Tried to divide by zero: %s" % e)

更新八进制数字 

在 Python 2.x 中，八进制字面量可以指定为 0755。在 Python 3 中，八进制必须指定为 0o755。

控制节点代码的字符串格式化 

使用 `str.format()` 以兼容 Python 2.6 

从 Python 2.6 开始，字符串获得了一个名为 format() 的方法来拼接字符串。然而，format() 的一个常用功能直到 Python 2.7 才添加，所以你需要记住在 Ansible 代码中不要使用它。

# Does not work in Python 2.6!
new_string = "Dear {}, Welcome to {}".format(username, location)

# Use this instead
new_string = "Dear {0}, Welcome to {1}".format(username, location)

上面的两个格式化字符串都将 format() 方法的位置参数映射到字符串中。但是，第一个版本在 Python 2.6 中不起作用。始终记住将数字放入占位符中，以使代码与 Python 2.6 兼容。

另请参阅

Python 关于格式化字符串的文档

对字节字符串使用百分号格式化 

在 Python 3.x 中，字节字符串没有 format() 方法。但是，它支持较旧的百分号格式化。

b_command_line = b'ansible-playbook --become-user %s -K %s' % (user, playbook_file)

注意

在 Python 3.5 中添加了百分号格式化

字节字符串的百分号格式化在 Python 3 的 3.5 版本中被重新添加回来。这对我们来说不是问题，因为 Python 3.5 是我们的最低版本。但是，如果您碰巧使用 Python 3.4 或更早的版本测试 Ansible 代码，您会发现这里的字节字符串格式化将不起作用。请升级到 Python 3.5 进行测试。

另请参阅

Python 关于百分号格式化的文档