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.1.tar.gz
(24.4 kB
view hashes)
Built Distribution
Close
Hashes for docstring_parser-0.14.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 14ac6ec1f1ba6905c4d8cb90fd0bc55394f5678183752c90e44812bf28d7a515 |
|
MD5 | b8333e91c69cfd9ba5ca962dbdf122dc |
|
BLAKE2b-256 | bed0106db829d226c2a2e9fdac490d466062559d29fd127ef3f1898625fe77b7 |