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.
Installation
Installation using pip
pip install docstring_parser
# or if you want to install it in a virtual environment
python -m venv venv # create environment
source venv/bin/activate # activate environment
python -m pip install docstring_parser
Installation using conda
- Download and install miniconda or anaconda
- Install the package from the conda-forge channel via:
conda install -c conda-forge docstring_parser- or create a new conda environment via
conda create -n my-new-environment -c conda-forge docstring_parser
Contributing
To set up the project:
git clone https://github.com/rr-/docstring_parser.git
cd docstring_parser
python -m venv venv # create environment
source venv/bin/activate # activate environment
pip install -e ".[dev]" # install as editable
pre-commit install # make sure pre-commit is setup
To run tests:
source venv/bin/activate
pytest
Release files for docstring-parser 0.18.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| docstring_parser-0.18.0.tar.gz | 29.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| docstring_parser-0.18.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 51.8 kB
Release files / docstring_parser-0.18.0.tar.gz
| Download URL | docstring_parser-0.18.0.tar.gz |
|---|---|
| Size | 29.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
292510982205c12b1248696f44959db3cdd1740237a968ea1e2e7a900eeb2015
|
|
BLAKE2b-256 checksum How to use checksums |
e04df332313098c1de1b2d2ff91cf2674415cc7cddab2ca1b01ae29774bd5fdf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Apr 14, 2026.
Transparency logRelease files / docstring_parser-0.18.0-py3-none-any.whl
| Download URL | docstring_parser-0.18.0-py3-none-any.whl |
|---|---|
| Size | 22.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b3fcbed555c47d8479be0796ef7e19c2670d428d72e96da63f3a40122860374b
|
|
BLAKE2b-256 checksum How to use checksums |
a75fed01f9a3cdffbd5a008556fc7b2a08ddb1cc6ace7effa7340604b1d16699
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Apr 14, 2026.
Transparency log
