Skip to main content

Parse Python docstrings in reST, Google and Numpydoc format

Project description

docstring_parser_fork

This is a fork of docstring_parser.

This fork fixes bugs that the upstream library has not fixed, and it also offers additional functionalities. To inspect the difference between this fort and the upstream, go to CHANGELOG.md and read the entries that start with "(Fork)".


Build

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_fork

# 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_fork

Installation using conda

  1. Download and install miniconda or anaconda
  2. 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:

pip install --user poetry

git clone https://github.com/rr-/docstring_parser.git
cd docstring_parser

poetry install
poetry run pre-commit install

To run tests:

poetry run pytest

Project details


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_fork-0.0.9.tar.gz (30.0 kB view details)

Uploaded Source

Built Distribution

docstring_parser_fork-0.0.9-py3-none-any.whl (40.3 kB view details)

Uploaded Python 3

File details

Details for the file docstring_parser_fork-0.0.9.tar.gz.

File metadata

  • Download URL: docstring_parser_fork-0.0.9.tar.gz
  • Upload date:
  • Size: 30.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.19

File hashes

Hashes for docstring_parser_fork-0.0.9.tar.gz
Algorithm Hash digest
SHA256 95b23cc5092af85080c716a6da68360f5ae4fcffa75f4a3aca5e539783cbcc3d
MD5 941bfa2ff6db494f2a1c7a24eb8cea33
BLAKE2b-256 170e8468b881277ff077e63c57ab5747ca0770bea76e1ca636a9ed45caec2fa7

See more details on using hashes here.

File details

Details for the file docstring_parser_fork-0.0.9-py3-none-any.whl.

File metadata

File hashes

Hashes for docstring_parser_fork-0.0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 0be85ad00cb25bf5beeb673e46e777facf0f47552fa3a7570d120ef7e3374401
MD5 d4e1c9683ba7aa9122bc6aa2248a7a77
BLAKE2b-256 79a9afc6140d68e260cdcc1214abbe924556cbd1ceaaa5aa7cd3b62eb739e02d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page