docstrings

Class info

🛈 DocStrings

Credits to pydantic-ai.

_infer_docstring_style

_infer_docstring_style(doc: str) -> DocstringStyle

Simplistic docstring style inference.

Source code in src/llmling_agent/utils/docstrings.py

def _infer_docstring_style(doc: str) -> DocstringStyle:
    """Simplistic docstring style inference."""
    for pattern, replacements, style in _docstring_style_patterns:
        matches = (
            re.search(pattern.format(replacement), doc, re.IGNORECASE | re.MULTILINE)
            for replacement in replacements
        )
        if any(matches):
            return style
    # fallback to google style
    return "google"

get_docstring_info

get_docstring_info(
    func: AnyCallable, sig: Signature, *, docstring_format: DocstringFormat = "auto"
) -> tuple[str, dict[str, str]]

Extract the fn description and parameter descriptions from a fn's docstring.

Returns:

Type	Description
tuple[str, dict[str, str]]	A tuple of (main function description, parameter descriptions).

Source code in src/llmling_agent/utils/docstrings.py

def get_docstring_info(
    func: AnyCallable,
    sig: Signature,
    *,
    docstring_format: DocstringFormat = "auto",
) -> tuple[str, dict[str, str]]:
    """Extract the fn description and parameter descriptions from a fn's docstring.

    Returns:
        A tuple of (main function description, parameter descriptions).
    """
    doc = func.__doc__
    if doc is None:
        return "", {}

    # see https://github.com/mkdocstrings/griffe/issues/293
    parent = cast(GriffeObject, sig)

    docstring_style = (
        _infer_docstring_style(doc) if docstring_format == "auto" else docstring_format
    )
    docstring = Docstring(doc, lineno=1, parser=docstring_style, parent=parent)
    with _disable_griffe_logging():
        sections = docstring.parse()

    params = {}
    if parameters := next(
        (p for p in sections if p.kind == DocstringSectionKind.parameters), None
    ):
        params = {p.name: p.description for p in parameters.value}

    main_desc = ""
    if main := next((p for p in sections if p.kind == DocstringSectionKind.text), None):
        main_desc = main.value

    return main_desc, params