Parse Python docstrings in reST, Google and Numpydoc format
Project description
docstring_parser
Parse Python docstrings. Currently support ReST, Google, Numpydoc-style and Epydoc docstrings.
Example usage:
>>> 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'
Read API Documentation.
Contributing
To set up the project:
pip install --user poetry
git clone https://github.com/rr-/pycrcmanip.git
cd pycrcmanip
poetry install
poetry run pre-commit install
To run tests:
poetry run pytest
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
docstring_parser-0.14.tar.gz
(24.1 kB
view hashes)
Built Distribution
Close
Hashes for docstring_parser-0.14-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 01f04c9b39356aa228fc0440a9cf3809d1764183e212ebfbbe28077591548f0f |
|
MD5 | f838e494042a012d197c244c128e0651 |
|
BLAKE2b-256 | 3d0f31fcf30f25dd0cd7a4e2ada5c34f10e80970ab685a5b7e2fe13adfcc9d93 |