Function getfuncargnames

src/_pytest/compat.py:108–173

Return the names of a function's mandatory arguments. Should return the names of all function arguments that: * Aren't bound to an instance or type as in instance or class methods. * Don't have default values. * Aren't bound with functools.partial. * Aren't replaced with mocks.

(
    function: Callable[..., object],
    *,
    name: str = "",
    cls: type | None = None,
)

def getfuncargnames(
    function: Callable[..., object],
    *,
    name: str = class="st">"",
    cls: type | None = None,
) -> tuple[str, ...]:
    class="st">"""Return the names of a function&class="cm">#x27;s mandatory arguments.

    Should return the names of all function arguments that:
    * Aren&class="cm">#x27;t bound to an instance or type as in instance or class methods.
    * Don&class="cm">#x27;t have default values.
    * Aren&class="cm">#x27;t bound with functools.partial.
    * Aren&class="cm">#x27;t replaced with mocks.

    The cls arguments indicate that the function should be treated as a bound
    method even though it&class="cm">#x27;s not unless the function is a static method.

    The name parameter should be the original name in which the function was collected.
    class="st">"""
    class="cm"># TODO(RonnyPfannschmidt): This function should be refactored when we
    class="cm"># revisit fixtures. The fixture mechanism should ask the node for
    class="cm"># the fixture names, and not try to obtain directly from the
    class="cm"># function object well after collection has occurred.

    class="cm"># The parameters attribute of a Signature object contains an
    class="cm"># ordered mapping of parameter names to Parameter instances.  This
    class="cm"># creates a tuple of the names of the parameters that don't have
    class="cm"># defaults.
    try:
        parameters = signature(function).parameters.values()
    except (ValueError, TypeError) as e:
        from _pytest.outcomes import fail

        fail(
            fclass="st">"Could not determine arguments of {function!r}: {e}",
            pytrace=False,
        )

    arg_names = tuple(
        p.name
        for p in parameters
        if (
            p.kind is Parameter.POSITIONAL_OR_KEYWORD
            or p.kind is Parameter.KEYWORD_ONLY
        )
        and p.default is Parameter.empty
    )
    if not name:
        name = function.__name__

    class="cm"># If this function should be treated as a bound method even though
    class="cm"># it's passed as an unbound method or function, and its first parameter
    class="cm"># wasn't defined as positional only, remove the first parameter name.
    if not any(p.kind is Parameter.POSITIONAL_ONLY for p in parameters) and (
        class="cm"># Not using `getattr` because we don't want to resolve the staticmethod.
        class="cm"># Not using `cls.__dict__` because we want to check the entire MRO.
        cls
        and not isinstance(