python - 以编程方式获取 python 函数参数的描述

Question

假设我有以下功能:

def get_fullname(first: str, last: str = "Miller"):
    """
    :param first: First name
    :param last: Last name
    :return: Fullname
    """
    return f"{first} {last}"

我知道我可以使用 inspect 模块获得有关函数的大量信息:

import inspect
spec = inspect.getfullargspec(get_fullname)
print(spec)
# FullArgSpec(args=['first', 'last'], varargs=None, varkw=None, defaults=('Miller',), kwonlyargs=[], kwonlydefaults=None, annotations={'first': <class 'str'>, 'last': <class 'str'>})

我是否可以通过编程方式获取这些参数的描述？看起来不可能，但只是确定一下。看起来这是 specifying types 的 PyCharm 方式.

Answer 1

您可以安装和使用docstring_parser :

import docstring_parser

def get_fullname(first: str, last: str = "Miller"):
    """
    :param first: First name
    :param last: Last name
    :return: Fullname
    """
    return f"{first} {last}"

doc = docstring_parser.parse(get_fullname.__doc__)
for param in doc.params:
    print(param.arg_name, param.description)
print(doc.returns.description)

这个输出:

first First name
last Last name
Fullname