以 reST、Google 和 Numpydoc 格式解析 Python 文档字符串
项目描述
docstring_parser
解析 Python 文档字符串。目前支持 ReST、Google、Numpydoc 风格和 Epydoc 文档字符串。
示例用法：
>>> from docstring_parser import parse
>>>
>>>
>>> docstring = parse(
... '''
... Short description
...
... Long description spanning multiple lines
... - First line
... - Second line
... - Third line
...
... :param name: description 1
... :param int priority: description 2
... :param str sender: description 3
... :raises ValueError: if name is invalid
... ''')
>>>
>>> docstring.long_description
'Long description spanning multiple lines\n- First line\n- Second line\n- Third line'
>>> docstring.params[1].arg_name
'priority'
>>> docstring.raises[0].type_name
'ValueError'
阅读API 文档。
贡献
要设置项目：
pip install --user poetry
git clone https://github.com/rr-/docstring_parser.git
cd docstring_parser
poetry install
poetry run pre-commit install
运行测试：
poetry run pytest
下载文件
下载适用于您平台的文件。如果您不确定要选择哪个，请了解有关安装包的更多信息。
源分布
docstring_parser-0.15.tar.gz
（26.8 kB
查看哈希）
内置分布
docstring_parser-0.15-py3-none-any.whl
（36.1 kB
视图哈希）