Question

我使用带有sphinx.ext.autodoc的Google风格文档字符串自动为我的函数生成文档，并确保它们在代码中正确自我记录。

我有一个功能def myfunc(id=None, size=None, hash=None)，可根据id 或 size + hash返回信息。如果我们以id作为参数，则不需要size和hash，如果我们将size和hash作为参数，那么id不需要。

使用sphinx，可以指定一个可选参数，但在这种情况下，我们不知道什么是强制性的，什么是可选的。这是一个例子：

def get_file(id=0, size=0, hash="")
    """
    Get file metadata.

    Args:
        id (int): id of the file.
        size (int): file size in bytes.
        hash (str): md5 hash of file.

    Returns:
        file_data (str): metadata information about the file.
    """
    if id:
        # Get file with id.
        ...
    elif size and hash:
        # Get file with size and hash.
        ...
    else:
        # Bad arguments, handle error.
        ...

    return file_data

问题是：如何判断文档字符串中哪些参数是必要的？

你很容易争辩说函数本身就是问题，即使结果是相同的，两个参数对也应该在不同的函数中：

def get_file_by_id(id)
    """
    Get file metadata from id.

    Args:
        id (int): id of the file.

    Returns:
        file_data (str): metadata information about the file.
    """

    # Get file with id.
    ...

    return file_data

def get_file_by_hash(size, hash)
    """
    Get file metadata from hash.

    Args:
        size (int): file size in bytes.
        hash (str): md5 hash of file.

    Returns:
        file_data (str): metadata information about the file.
    """

    # Get file with hash+size.
    ...

    return file_data

但是在这种情况下，如果可能的话，首选单个函数，因为该函数是对使用单个函数的另一个API的绑定。

Answer 1

根据文档here，以下示例方法定义：

def module_level_function(param1, param2=None, *args, **kwargs):

docstring的定义是：

Args:
    param1 (int): The first parameter.
    param2 (:obj:`str`, optional): The second parameter. Defaults to None.
        Second line of description should be indented.
    *args: Variable length argument list.
    **kwargs: Arbitrary keyword arguments.

因此，您明确说明了所指示的可选，否则它将被理解为强制性参数。

记录相同功能的不同论证可能性

1 个答案: