66 lines
2.2 KiB
Python
66 lines
2.2 KiB
Python
|
# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
|
||
|
|
# For details: https://github.com/pylint-dev/pylint/blob/main/LICENSE
|
||
|
|
# Copyright (c) https://github.com/pylint-dev/pylint/blob/main/CONTRIBUTORS.txt
|
||
|
|
|
||
|
|
"""Checker for deprecated builtins."""
|
||
|
|
|
||
|
|
from __future__ import annotations
|
||
|
|
|
||
|
|
from typing import TYPE_CHECKING
|
||
|
|
|
||
|
|
from astroid import nodes
|
||
|
|
|
||
|
|
from pylint.checkers import BaseChecker
|
||
|
|
from pylint.checkers.utils import only_required_for_messages
|
||
|
|
|
||
|
|
if TYPE_CHECKING:
|
||
|
|
from pylint.lint import PyLinter
|
||
|
|
|
||
|
|
BAD_FUNCTIONS = ["map", "filter"]
|
||
|
|
# Some hints regarding the use of bad builtins.
|
||
|
|
LIST_COMP_MSG = "Using a list comprehension can be clearer."
|
||
|
|
BUILTIN_HINTS = {"map": LIST_COMP_MSG, "filter": LIST_COMP_MSG}
|
||
|
|
|
||
|
|
|
||
|
|
class BadBuiltinChecker(BaseChecker):
|
||
|
|
name = "deprecated_builtins"
|
||
|
|
msgs = {
|
||
|
|
"W0141": (
|
||
|
|
"Used builtin function %s",
|
||
|
|
"bad-builtin",
|
||
|
|
"Used when a disallowed builtin function is used (see the "
|
||
|
|
"bad-function option). Usual disallowed functions are the ones "
|
||
|
|
"like map, or filter , where Python offers now some cleaner "
|
||
|
|
"alternative like list comprehension.",
|
||
|
|
)
|
||
|
|
}
|
||
|
|
|
||
|
|
options = (
|
||
|
|
(
|
||
|
|
"bad-functions",
|
||
|
|
{
|
||
|
|
"default": BAD_FUNCTIONS,
|
||
|
|
"type": "csv",
|
||
|
|
"metavar": "<builtin function names>",
|
||
|
|
"help": "List of builtins function names that should not be "
|
||
|
|
"used, separated by a comma",
|
||
|
|
},
|
||
|
|
),
|
||
|
|
)
|
||
|
|
|
||
|
|
@only_required_for_messages("bad-builtin")
|
||
|
|
def visit_call(self, node: nodes.Call) -> None:
|
||
|
|
if isinstance(node.func, nodes.Name):
|
||
|
|
name = node.func.name
|
||
|
|
# ignore the name if it's not a builtin (i.e. not defined in the
|
||
|
|
# locals nor globals scope)
|
||
|
|
if not (name in node.frame() or name in node.root()):
|
||
|
|
if name in self.linter.config.bad_functions:
|
||
|
|
hint = BUILTIN_HINTS.get(name)
|
||
|
|
args = f"{name!r}. {hint}" if hint else repr(name)
|
||
|
|
self.add_message("bad-builtin", node=node, args=args)
|
||
|
|
|
||
|
|
|
||
|
|
def register(linter: PyLinter) -> None:
|
||
|
|
linter.register_checker(BadBuiltinChecker(linter))
|