Skip to main content

文档助手

fabric.docs.unwrap_tasks(module, hide_nontasks=False)

使用包装函数替换 module 上的任务对象。

具体来说,查找 WrappedCallableTask 的实例,并用他们的 .wrapped 属性(原始的装饰函数)替换它们。

这是为了与Sphinx autodoc工具一起使用,在项目的 conf.py 的底部附近运行。它确保autodoc扩展将具有对函数签名等方面的“真实”函数的完全访问。没有使用 unwrap_tasks,autodoc无法访问函数签名(虽然它能够看到例如 __doc__。)

例如,在您的 conf.py 的底部:

from fabric.docs import unwrap_tasks
import my_package.my_fabfile
unwrap_tasks(my_package.my_fabfile)

你可以超越和超越,明确 隐藏 所有非任务功能,通过说 hide_nontasks=True。这将重命名所有失败的对象是“是一个任务吗?检查它们看起来是私人的,这将导致autodoc跳过他们。

因此,当您在具有实际任务的子例程中混合fabfile并想要将 just 记录为实际任务时,hide_nontasks 非常有用。

如果在实际的使用Fabric-code的会话(而不是Sphinx conf.py)中运行,请立即就医。