Skip to content

toolr.utils._docstrings

parse_docstring 

parse_docstring(docstring: str) -> Docstring

Parse a docstring into a Docstring object.

Source code in python/toolr/utils/_docstrings.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
def parse_docstring(docstring: str) -> Docstring:
    """Parse a docstring into a Docstring object."""
    parser = GoogleParser()
    parse_docstring = parser.parse(docstring)
    short_description = parse_docstring.short_description
    long_description = parse_docstring.long_description or short_description

    if TYPE_CHECKING:
        assert short_description is not None
        assert long_description is not None

    params = {param.arg_name: param.description for param in parse_docstring.params}
    return Docstring(
        short_description=short_description,
        long_description=long_description,
        params=params,
    )