parse_argument_docs

函数私有源码

v_1: list[DocArgument] = parse_argument_docs(
    func: Any,
    docstring: Sequence[str],
    func_name: str | None = None,
    warn_supp: bool = False,
)

危险

这是一个私有函数，用户不应该自行调用。

解析与函数参数相关的 docstring。

该函数是parse_func_docs(...)的一部分。故此，不建议直接调用该函数。

参数

输入

参数	类型	必选	说明
func	Any		待解析的函数对象。可以是普通函数或方法。
docstring	Sequence[str]		所有参数按行保存的 docstring。该值来源于解析出的Section对象。
func_name	str | None		用来在信息中展示的函数名称。如果未设置，会自动推断该名称。
warn_supp	bool		布尔标记。如果设置了，则不会在解析过程中报出任何警告信息，这是为了排除对某些特殊/私有函数的报告。

输出

参数	类型	说明
v_1	list[DocArgument]	从所有输入参数中解析后的 docstring 列表。