Method: pylint.checkers.deprecated.DeprecatedMixin.deprecated_arguments
Calls: 10504, Exceptions: 0, Paths: 1Back
Path 1: 10504 calls (1.0)
'builtins.print' (1012) 'print' (1012) 'range' (287) 'builtins.range' (287) 'builtins.super' (166) 'super' (166) 'builtins.str.format' (151) 'format' ...
() (10504)
1def deprecated_arguments(self, method: str) -> Iterable[tuple[int | None, str]]:
2 """Callback returning the deprecated arguments of method/function.
3
4 Args:
5 method (str): name of function/method checked for deprecated arguments
6
7 Returns:
8 collections.abc.Iterable in form:
9 ((POSITION1, PARAM1), (POSITION2: PARAM2) ...)
10 where
11 * POSITIONX - position of deprecated argument PARAMX in function definition.
12 If argument is keyword-only, POSITIONX should be None.
13 * PARAMX - name of the deprecated argument.
14 E.g. suppose function:
15
16 .. code-block:: python
17 def bar(arg1, arg2, arg3, arg4, arg5='spam')
18
19 with deprecated arguments `arg2` and `arg4`. `deprecated_arguments` should return:
20
21 .. code-block:: python
22 ((1, 'arg2'), (3, 'arg4'))
23 """
24 # pylint: disable=unused-argument
25 return ()