python - Doctests 在 C 扩展和 Python3 上因 UnicodeDecodeError 而失败

Question

我很难让我的测试框架同时适用于 Python2 和 Python3 的 C 扩展模块。我喜欢通过 doctest 运行我的文档字符串，以确保我没有向用户提供不良信息，因此我想将运行 doctest 作为我测试的一部分。

我不相信我的问题的根源是文档字符串本身，而是 doctest 模块如何尝试读取我的扩展模块。如果我用 Python2 运行 doctest(在针对 Python2 编译的模块上)，我会得到我期望的输出:

$ python -m doctest myext.so -v
...
1 items passed all tests:
98 tests in myext.so
98 tests in 1 items.
98 passed and 0 failed.
Test passed.

但是，当我使用 Python3 执行相同操作时，我得到一个 UnicodeDecodeError:

$ python3 -m doctest myext3.so -v
Traceback (most recent call last):
...
  File "/usr/local/Cellar/python3/3.3.3/Frameworks/Python.framework/Versions/3.3/lib/python3.3/doctest.py", line 223, in _load_testfile
    return f.read(), filename
  File "/usr/local/Cellar/python3/3.3.3/Frameworks/Python.framework/Versions/3.3/lib/python3.3/codecs.py", line 301, in decode
    (result, consumed) = self._buffer_decode(data, self.errors, final)
UnicodeDecodeError: 'utf-8' codec can't decode byte 0xcf in position 0: invalid continuation byte

为了获得更多信息，我通过 pytest 运行它并进行完整回溯:

$ python3 -m pytest --doctest-glob "*.so" --full-trace
...
self = <encodings.utf_8.IncrementalDecoder object at 0x102ff5110>
input = b'\xcf\xfa\xed\xfe\x07\x00\x00\x01\x03\x00\x00\x00\x08\x00\x00\x00\r\x00\x00\x00\xd0\x05\x00\x00\x85\x00\x00\x00\x00\x...edString\x00_PyUnicode_FromString\x00_Py_BuildValue\x00__Py_FalseStruct\x00__Py_TrueStruct\x00dyld_stub_binder\x00\x00'
final = True

    def decode(self, input, final=False):
        # decode input (taking the buffer into account)
        data = self.buffer + input
>       (result, consumed) = self._buffer_decode(data, self.errors, final)
E       UnicodeDecodeError: 'utf-8' codec can't decode byte 0xcf in position 0: invalid continuation byte

/usr/local/Cellar/python3/3.3.3/Frameworks/Python.framework/Versions/3.3/lib/python3.3/codecs.py:301: UnicodeDecodeError    

---

看起来 doctest 实际上是读取 .so 文件来获取文档字符串(而不是导入模块)，但是 Python3 没有'知道如何解码输入。我可以通过自己尝试读取 .so 文件来复制字节字符串和回溯来确认这一点:

$ python3
Python 3.3.3 (default, Dec 10 2013, 20:13:18) 
[GCC 4.2.1 Compatible Apple LLVM 5.0 (clang-500.2.79)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> open('myext3.so').read()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/usr/local/Cellar/python3/3.3.3/Frameworks/Python.framework/Versions/3.3/lib/python3.3/codecs.py", line 301, in decode
    (result, consumed) = self._buffer_decode(data, self.errors, final)
UnicodeDecodeError: 'utf-8' codec can't decode byte 0xcf in position 0: invalid continuation byte
>>> open('myext3.so', 'rb').read()
b'\xcf\xfa\xed\xfe\x07\x00\x00\x01\x03\x00\x00\x00\x08\x00\x00\x00\r\x00\x00\x00\xd0\x05...'

---

有没有其他人遇到过这个问题？是否有标准(或不太标准)的方法让 doctest 对 python3 上的 C 扩展模块执行测试？

更新:我还应该补充一点，我在 Travis-CI ( see here ) 上得到了相同的结果，所以它不是特定于我的本地构建。

Answer 1

我已经找到解决这个问题的方法，所以我会发布它，但我发现它相当不令人满意。我仍在为此寻找更优雅/更简单的解决方案。

---

doctest.py 存在三个问题，需要克服这些问题才能使其正常工作:

1) 让 doctest 将 .so 文件视为 python 模块。

如果您查看 doctest.py 源代码，您会注意到在测试运行器中有一个类似于此的 block (取决于您运行的 python 版本):

if filename.endswith(".py"):
    # It is a module -- insert its dir into sys.path and try to
    # import it. If it is part of a package, that possibly
    # won't work because of package imports.
    dirname, filename = os.path.split(filename)
    sys.path.insert(0, dirname)
    m = __import__(filename[:-3])
    del sys.path[0]
    failures, _ = testmod(m)
else:
    failures, _ = testfile(filename, module_relative=False)

这里发生的事情是 doctest.py 正在检查“.py”扩展名，如果是这样，文件将作为 python 模块加载，否则文件将被读取，就好像它是文本(就像一个 README.rst 可能)。我们需要获取 doctest.py 来确认扩展名为“.so”的文件是一个 python 模块。为此，只需修改此 if block 以读取

即可添加对“.so”扩展名的检查

if filename.endswith(".py") or filename.endswith(".so"):
    ...

2)获取doctest识别C扩展模块中的函数

doctest.py 使用 inspect.isfunction函数以确定在模块对象中递归搜索文档字符串时哪些对象是函数。这个函数的问题是它只识别用 python 编写的函数，而不是用 C 编写的函数(python 将 C 扩展函数识别为内置函数)。因此，为了在模块中递归时识别我们的函数，我们需要使用 inspect.isbuiltin。相反。

为了纠正这个问题，我们需要在 doctest.py 中找到 DocTestFinder._find 方法并更改它查找函数的方式。我转换了

# Recurse to functions & classes.
if ((inspect.isfunction(val) or inspect.isclass(val)) and
    self._from_module(module, val)):
    self._find(tests, val, valname, module, source_lines,
               globs, seen)

到

# Recurse to functions & classes.
if ((inspect.isbuiltin(val) or inspect.isclass(val)) and
    self._from_module(module, val)):
    self._find(tests, val, valname, module, source_lines,
               globs, seen)

3)正确删除.so文件上的版本标签(仅限Python3)。

在 Python3 上，C 扩展可以用版本标识符标记(即“myext.cpython-3mu.so”，请参阅 PEP 3149)。我们需要知道如何在 doctest.py 测试运行器中进行初始导入时删除它。

为此，我转换了行

m = __import__(filename[:-3])

到

from sysconfig import get_config_var
m = __import__(filename[:-3] if filename.endswith(".py") else filename.replace(get_config_var("EXT_SUFFIX"), ""))

只有 Python3 才需要。

---

进行这些修改后，我可以让 doctest 在 Python2 和 Python3 上按预期工作。由于这些修改相当烦人，我制作了一个 patch_doctest.py 脚本，它会自动执行此操作并将修补后的 doctest.py 放在您的当前目录中。你可以得到这个文件here如果你想使用它。然后您可以像这样在扩展模块上运行测试

$ python2 patch_doctest.py
$ python2 -m doctest myext2.so
$ rm doctest.py
$ python3 patch_doctest.py
$ python3 -m doctest myext3.so

作为这有效的证据，here are the new Travis-CI results .