我想解析一个numpydoc docstring并以编程方式访问每个组件。
例如:
def foobar(a, b):
'''Something something
Parameters
----------
a : int, default: 5
Does something cool
b : str
Wow
'''
我想做的是:
parsed = magic_parser(foobar)
parsed.text # Something something
parsed.a.text # Does something cool
parsed.a.type # int
parsed.a.default # 5
我一直在搜索，发现了诸如numpydoc和napoleon之类的东西，但是我没有找到如何在自己的程序中使用它们的好线索。我将不胜感激。
最佳答案
您可以使用numpydoc中的NumpyDocString将文档字符串解析为Python友好的结构。
这是一个如何使用它的示例:
from numpydoc.docscrape import NumpyDocString
class Photo():
"""
Array with associated photographic information.
Parameters
----------
x : type
Description of parameter `x`.
y
Description of parameter `y` (with type not specified)
Attributes
----------
exposure : float
Exposure in seconds.
Methods
-------
colorspace(c='rgb')
Represent the photo in the given colorspace.
gamma(n=1.0)
Change the photo's gamma exposure.
"""
def __init__(x, y):
print("Snap!")
doc = NumpyDocString(Photo.__doc__)
print(doc["Summary"])
print(doc["Parameters"])
print(doc["Attributes"])
print(doc["Methods"])
但是，由于我不了解的原因，这不适用于您给出的示例(也没有很多我想在其上运行的代码)。相反，您需要根据用例使用特定的
FunctionDoc或ClassDoc类。from numpydoc.docscrape import FunctionDoc
def foobar(a, b):
"""
Something something
Parameters
----------
a : int, default: 5
Does something cool
b : str
Wow
"""
doc = FunctionDoc(foobar)
print(doc["Parameters"])
我通过查看this test in their source code弄清了所有这些。因此，这并没有真正记录在案，但希望足以让您开始使用。
关于python - 如何解析numpydoc文档字符串并访问组件？，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/37929851/