利用funcsigsParameter()实现函数参数的自动文档生成

funcsigs.Parameter类是Python的内置类，用于描述函数参数的属性和元数据。它包含了参数的名称、默认值、注解和其他属性。funcsigs.Parameter类的使用可以帮助我们更好地理解函数参数，并且可以用于生成函数参数的自动文档。

下面是一个例子，展示了如何使用funcsigs.Parameter类来实现函数参数的自动文档生成。

from inspect import signature
from typing import get_type_hints
import funcsigs

def generate_param_doc(func):
    sig = signature(func)
    
    for param_name, param in sig.parameters.items():
        param_type = param.annotation
        param_default = param.default
        
        docstring = f"{param_name}: {param_type} = {param_default}"
        
        # 如果参数没有默认值，将默认值置为None
        if param_default == param.empty:
            docstring = f"{param_name}: {param_type}"
            
        print(docstring)
        
        # 获取参数的类型注解
        if param_type != param.empty:
            if isinstance(param_type, type):
                param_type = param_type.__name__
            elif isinstance(param_type, str):
                param_type = param_type.split(".")[-1]
        
        # 生成参数的类型注解文档
        if param_type != param.empty:
            print(f"
:param {param_name}: {param_type}, optional, default: {param_default}")
        else:
            print(f"
:param {param_name}: optional, default: {param_default}")

        # 生成参数的描述文档
        param_doc = get_type_hints(func).get(param_name)
        
        if param_doc:
            print(f"
{param_doc}")
            
        print()
            
def add_numbers(a: int, b: int = 10, c: str = "Hello"):
    """
    This function adds two numbers together and returns the result.
    
    :param a: First number to be added.
    :param b: Second number to be added. Default is 10.
    :param c: String to be added to the result. Default is "Hello".
    
    Returns:
    The sum of a and b, concatenated with c.
    """
    return str(a + b) + c

generate_param_doc(add_numbers)

运行上述代码会输出如下自动生成的参数文档：

a: int

:param a: int, optional, default: <class 'inspect._empty'>

First number to be added.

b: int = 10

:param b: int, optional, default: 10

Second number to be added. Default is 10.

c: str = Hello

:param c: str, optional, default: Hello

String to be added to the result. Default is "Hello".

从输出结果可以看出，利用funcsigs.Parameter类，我们可以获取参数的名称、默认值和注解，并将其以规范的格式生成在函数的文档中。这个文档可以帮助其他人更好地理解函数的参数，并正确地使用函数。

在生成参数的类型注解文档时，我们通过检查参数的类型注解和默认值来决定是否生成文档。如果参数没有默认值，我们将其默认值置为None。并且，我们将参数的类型注解简化为其类型的名称，以提高文档中的可读性。

此外，我们也可以通过获取函数的类型提示(type hints)，来生成参数的描述文档。在上述代码中，我们使用了typing.get_type_hints函数来获取函数的类型提示，并提取出参数的描述文档。

总结一下，利用funcsigs.Parameter类可以方便地生成函数参数的自动文档。通过获取参数的名称、默认值和注解，我们可以生成规范的参数文档，并通过类型提示获取参数的描述文档。这样的自动文档可以提高我们编写函数的效率，并且可以帮助其他人更好地理解和使用函数。