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 的书：移植到 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 在控制节点上的代码、模块和 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 的 subprocess 库，并且应期望从该库返回字节字符串。

在 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 副本

如果系统副本的版本比 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.5 中被重新添加回 Python 3。这对我们来说不是问题，因为 Python 3.5 是我们的最低版本。但是，如果您碰巧使用 Python 3.4 或更早版本测试 Ansible 代码，您会发现这里的字节字符串格式化将不起作用。请升级到 Python 3.5 进行测试。

另请参阅

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