numpy.lib.add_newdoc#

lib.add_newdoc(place, obj, doc, warn_on_python=True)[源代码]#

为现有对象添加文档，通常是 C 中定义的对象

其目的是允许更轻松地编辑文档字符串，而无需重新编译。这主要用于 NumPy 内部。

参数:

placestr

要导入的模块的绝对名称

objstr 或 None

要添加文档的对象的名称，通常是类或函数名。

doc{str, Tuple[str, str], List[Tuple[str, str]]}

如果为字符串，则为应用于 obj 的文档

如果为元组，则第一个元素被解释为 obj 的属性，第二个元素被解释为要应用的文档字符串 - (method, docstring)

如果为列表，则列表中的每个元素都应为长度为二的元组 - [(method1, docstring1), (method2, docstring2), ...]

warn_on_pythonbool

如果为 True（默认值），当此函数用于为纯 Python 对象附加文档时，会发出 UserWarning。

注意

如果文档字符串无法写入，此例程从不引发错误，但如果被文档化的对象不存在，则会引发错误。

此例程无法修改只读文档字符串，例如在新式类或内置函数中出现的文档字符串。由于此例程从不引发错误，调用者必须手动检查文档字符串是否已更改。

由于此函数从 C 级字符串对象中获取 char * 并将其放入 obj 类型的 tp_doc 槽中，它违反了许多 C-API 最佳实践，具体如下：

如果可能，应避免使用此函数。