docstring-parser

Warnings

• breaking In version 0.17.0, the 'parse' function now requires the 'style' parameter to be explicitly set. Omitting it will raise a TypeError.
  Fix: Update function calls to include the 'style' parameter, e.g., 'parse(docstring, style=DocstringStyle.AUTO)'.
• deprecated The 'parse_from_object' function is deprecated and will be removed in a future release. Use 'parse' with the appropriate style parameter instead.
  Fix: Replace calls to 'parse_from_object' with 'parse' and specify the 'style' parameter.
• gotcha When parsing docstrings with the 'parse' function, ensure that the 'style' parameter matches the docstring format (e.g., 'reST', 'Google', 'Numpydoc') to avoid parsing errors.
  Fix: Always specify the correct 'style' parameter when calling 'parse'.

Install

• pip install docstring-parser Install docstring-parser

Imports

• parse

  from docstring_parser import parse

  Ensure correct import path to access the 'parse' function.

Quickstart

A quickstart guide demonstrating how to parse a sample docstring using the 'parse' function from docstring_parser.

from docstring_parser import parse

# Sample docstring
docstring = """
This is a sample function.

:param x: The input value
:type x: int
:return: The squared value of x
:rtype: int
"""

# Parse the docstring
parsed = parse(docstring)

# Access parsed components
print(f"Description: {parsed.short_description}")
print(f"Parameters: {parsed.params}")
print(f"Returns: {parsed.returns}")