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

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.18.0.tar.gz (29.3 kB view details)

Uploaded Apr 14, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

docstring_parser-0.18.0-py3-none-any.whl (22.5 kB view details)

Uploaded Apr 14, 2026 Python 3

File details

Details for the file docstring_parser-0.18.0.tar.gz.

File metadata

Download URL: docstring_parser-0.18.0.tar.gz
Upload date: Apr 14, 2026
Size: 29.3 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for docstring_parser-0.18.0.tar.gz
Algorithm	Hash digest
SHA256	`292510982205c12b1248696f44959db3cdd1740237a968ea1e2e7a900eeb2015`
MD5	`52dd8769b2edd113ee5ae970c1307f9b`
BLAKE2b-256	`e04df332313098c1de1b2d2ff91cf2674415cc7cddab2ca1b01ae29774bd5fdf`

See more details on using hashes here.

Provenance

The following attestation bundles were made for docstring_parser-0.18.0.tar.gz:

Publisher: build.yml on rr-/docstring_parser

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: docstring_parser-0.18.0.tar.gz
- Subject digest: 292510982205c12b1248696f44959db3cdd1740237a968ea1e2e7a900eeb2015
- Sigstore transparency entry: 1292684953
- Sigstore integration time: Apr 14, 2026
Source repository:
- Permalink: rr-/docstring_parser@87dca55a7b5bdc854ad1d190f1c461015ba5f008
- Branch / Tag: refs/tags/0.18.0
- Owner: https://github.com/rr-
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: build.yml@87dca55a7b5bdc854ad1d190f1c461015ba5f008
- Trigger Event: push