python - 使用 pdoc3 获取用户格式化输出

Question

我必须从一个文件夹中分析一大堆以前创建.py的文件，并从中收集信息以将其存储在数据库中。该信息应包括每个.py文件中所有函数的名称及其参数，以及从 Docstring 获得的任何函数的可选文档（如果可用）。

使用pdoc3我从这个来源开始：

import math

def Add(val1, val2):
    """
    Adds two values.
    
    Author: Mike Smith.
    
    Args:
        val1 (int): First value.
        val3 (int): Second value.
    
    Returns:
        int: va1 plus val2.
    """
    return val1 + val2

def Sqrt(val):
    return math.sqrt(val)

我得到这个文本输出：

Module functions
================

Functions
---------

    
`Sqrt(val)`
:   

    
`Add(val1, val2)`
:   Adds two values.
    
    Author: Mike Smith.
    
    Args:
        val1 (int): First value.
        val3 (int): Second value.
    
    Returns:
        int: va1 plus val2.

如您所见，出现了一些问题：如果注释状态为 val3 而不是 val2，则不会发出警告或错误。此外，非关键字（作为作者）只是在 html 中作为纯文本给出。最后，输出格式对于解析第二个程序非常冗长。

我想知道，是否有任何方法可以更改所选格式的输出格式，包括所需的关键字+结构，如果 Docstrings 与参数或返回不匹配，则会发出一些警告？

注意：如果我的请求无法通过上面列出的这些方式实现，我愿意更改 Docstring 样式（当前使用 Google 的）或文档生成器工具。

谢谢！

标签： python