Function extract_class_info

python/scripts/generate-docs.py:257–322

Extract documentation from a class.

(
    cls: griffe_t.Class, class_name: str, config: dict
)

def extract_class_info(
    cls: griffe_t.Class, class_name: str, config: dict
) -> dict[str, Any]:
    """Extract documentation from a class."""
    griffe_module = load_griffe()
    doc = parse_docstring(cls.docstring.value if cls.docstring else None)

    info = {
        "name": class_name,
        "access": config.get("access"),
        "source_link": get_source_link(cls),
        "description": doc["description"],
        "deprecated": doc.get("deprecated"),
        "properties": [],
        "methods": [],
    }

    # Extract properties/attributes
    for name, member in cls.members.items():
        if name.startswith("_"):
            continue
        if isinstance(member, griffe_module.Attribute):
            attr_doc = member.docstring.value if member.docstring else ""
            info["properties"].append(
                {
                    "name": name,
                    "type": format_type(member.annotation),
                    "description": attr_doc.strip() if attr_doc else "",
                }
            )

    # Extract methods
    for name, member in cls.members.items():
        if name.startswith("_"):
            continue
        if isinstance(member, griffe_module.Function):
            method_doc = parse_docstring(
                member.docstring.value if member.docstring else None
            )

            params = []
            for p in member.parameters:
                if p.name in ("self", "cls"):
                    continue
                params.append(
                    {
                        "name": p.name,
                        "type": format_type(p.annotation),
                        "optional": p.default is not None,
                        "description": method_doc["params"].get(p.name, ""),
                    }
                )

            info["methods"].append(
                {
                    "name": name,
                    "source_link": get_source_link(member),
                    "description": method_doc["description"],