gpt4 book ai didi

python - 狮身人面像拿破仑文档函数可以返回多个参数吗?

转载 作者:IT老高 更新时间:2023-10-28 20:59:05 25 4
gpt4 key购买 nike

我正在尝试使用 Google 代码样式来记录一个函数,然后我使用带有拿破仑扩展的 sphinx 来为其创建文档。该函数的不寻常之处在于它返回两个参数。我不认为拿破仑能解决这个问题。如果是这样,有人可以告诉我他们是如何处理的吗?

def foo(a):
'''one line summary

longer explanation

Args:
a (int): parameter description

Returns:
servers (list): list of servers to use
msg (str): logging message string
'''
pass

也许我收到一条消息,说返回多个参数不是很好的编码风格,但你能做到吗?生成的 html 将这两行视为一个参数描述的一部分。如果我在服务器和 msg 行之间添加一个换行符,它会有所帮助,但它仍在记录一个 arg。

最佳答案

Python 只返回一个对象。如果你打电话

serv,msg = foo(myinput)

然后你显式扩展了函数返回时生成的 expression_list 元组

return servers,msg

你的文档字符串应该读到这样的东西(拿破仑谷歌风格)

"""
one line summary

longer explanation

Args:
a (int): parameter description

Returns:
(tuple): tuple containing:

servers(list) servers to use
msg (str): logging message string
"""

或者使用 Napoleon NumPy 风格:

"""
one line summary

longer explanation

Parameters
----------
a : int
parameter description

Returns
-------
servers : list
servers to use
msg : str
logging message string
"""

查看return 的python 文档也许expression_list

关于python - 狮身人面像拿破仑文档函数可以返回多个参数吗?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/29221551/

25 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com