Function inspect

src/attr/_next_gen.py:651–674

Inspect the class and return its effective build parameters. Warning: This feature is currently **experimental** and is not covered by our strict backwards-compatibility guarantees. Args: cls: The *attrs*-decorated class to inspect. Returns: The ef

(cls)

def inspect(cls):
    """
    Inspect the class and return its effective build parameters.

    Warning:
        This feature is currently **experimental** and is not covered by our
        strict backwards-compatibility guarantees.

    Args:
        cls: The *attrs*-decorated class to inspect.

    Returns:
        The effective build parameters of the class.

    Raises:
        NotAnAttrsClassError: If the class is not an *attrs*-decorated class.

    .. versionadded:: 25.4.0
    """
    try:
        return cls.__dict__["__attrs_props__"]
    except KeyError:
        msg = f"{cls!r} is not an attrs-decorated class."
        raise NotAnAttrsClassError(msg) from None