docstring_parser_extract_description_and_parameter_metadata.py

1from docstring_parser import parse
2
3def example_function(name, age=None):
4    """
5    Short description of the function.
6
7    Longer description that spans multiple lines and provides
8    more context about what the function does.
9
10    :param name: The name of the person.
11    :param age: The age of the person (optional).
12    :return: A greeting string.
13    """
14    pass
15
16# Parse the docstring of the function
17docstring = parse(example_function.__doc__)
18
19# Accessing components
20print(f"Short Description: {docstring.short_description}")
21print(f"Long Description: {docstring.long_description}")
22
23for param in docstring.params:
24    print(f"Parameter: {param.arg_name}")
25    print(f"  Description: {param.description}")
26    print(f"  Type: {param.type_name}")