mirror of
https://fuchsia.googlesource.com/third_party/github.com/pylint-dev/pylint
synced 2024-09-21 07:58:04 +00:00
152 lines
6.1 KiB
Python
152 lines
6.1 KiB
Python
|
# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
|
||
|
# For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
|
||
|
# Copyright (c) https://github.com/PyCQA/pylint/blob/main/CONTRIBUTORS.txt
|
||
|
|
||
|
from typing import TYPE_CHECKING
|
||
|
|
||
|
from astroid import nodes
|
||
|
|
||
|
from pylint.checkers import BaseChecker
|
||
|
from pylint.interfaces import HIGH, IAstroidChecker
|
||
|
|
||
|
if TYPE_CHECKING:
|
||
|
from pylint.lint import PyLinter
|
||
|
|
||
|
|
||
|
class DunderCallChecker(BaseChecker):
|
||
|
"""Check for unnecessary dunder method calls.
|
||
|
|
||
|
Docs: https://docs.python.org/3/reference/datamodel.html#basic-customization
|
||
|
We exclude __init__, __new__, __subclasses__, __init_subclass__,
|
||
|
__set_name__, __class_getitem__, __missing__, __exit__, __await__,
|
||
|
__del__, __aexit__, __getnewargs_ex__, __getnewargs__, __getstate__,
|
||
|
__setstate__, __reduce__, __reduce_ex__
|
||
|
since these either have no alternative method of being called or
|
||
|
have a genuine use case for being called manually.
|
||
|
"""
|
||
|
|
||
|
__implements__ = IAstroidChecker
|
||
|
|
||
|
includedict = {
|
||
|
"__repr__": "Use repr built-in function",
|
||
|
"__str__": "Use str built-in function",
|
||
|
"__bytes__": "Use bytes built-in function",
|
||
|
"__format__": "Use format built-in function, format string method, or f-string",
|
||
|
"__lt__": "Use < operator",
|
||
|
"__le__": "Use <= operator",
|
||
|
"__eq__": "Use == operator",
|
||
|
"__ne__": "Use != operator",
|
||
|
"__gt__": "Use > operator",
|
||
|
"__ge__": "Use >= operator",
|
||
|
"__hash__": "Use hash built-in function",
|
||
|
"__bool__": "Use bool built-in function",
|
||
|
"__getattr__": "Access attribute directly or use getattr built-in function",
|
||
|
"__getattribute__": "Access attribute directly or use getattr built-in function",
|
||
|
"__setattr__": "Set attribute directly or use setattr built-in function",
|
||
|
"__delattr__": "Use del keyword",
|
||
|
"__dir__": "Use dir built-in function",
|
||
|
"__get__": "Use get method",
|
||
|
"__set__": "Use set method",
|
||
|
"__delete__": "Use del keyword",
|
||
|
"__instancecheck__": "Use isinstance built-in function",
|
||
|
"__subclasscheck__": "Use issubclass built-in function",
|
||
|
"__call__": "Invoke instance directly",
|
||
|
"__len__": "Use len built-in function",
|
||
|
"__length_hint__": "Use length_hint method",
|
||
|
"__getitem__": "Access item via subscript",
|
||
|
"__setitem__": "Set item via subscript",
|
||
|
"__delitem__": "Use del keyword",
|
||
|
"__iter__": "Use iter built-in function",
|
||
|
"__next__": "Use next built-in function",
|
||
|
"__reversed__": "Use reversed built-in funciton",
|
||
|
"__contains__": "Use in keyword",
|
||
|
"__add__": "Use + operator",
|
||
|
"__sub__": "Use - operator",
|
||
|
"__mul__": "Use * operator",
|
||
|
"__matmul__": "Use @ operator",
|
||
|
"__truediv__": "Use / operator",
|
||
|
"__floordiv__": "Use // operator",
|
||
|
"__mod__": "Use % operator",
|
||
|
"__divmod__": "Use divmod built-in function",
|
||
|
"__pow__": "Use ** operator or pow built-in function",
|
||
|
"__lshift__": "Use << operator",
|
||
|
"__rshift__": "Use >> operator",
|
||
|
"__and__": "Use & operator",
|
||
|
"__xor__": "Use ^ operator",
|
||
|
"__or__": "Use | operator",
|
||
|
"__radd__": "Use + operator",
|
||
|
"__rsub__": "Use - operator",
|
||
|
"__rmul__": "Use * operator",
|
||
|
"__rmatmul__": "Use @ operator",
|
||
|
"__rtruediv__": "Use / operator",
|
||
|
"__rfloordiv__": "Use // operator",
|
||
|
"__rmod__": "Use % operator",
|
||
|
"__rdivmod__": "Use divmod built-in function",
|
||
|
"__rpow__": "Use ** operator or pow built-in function",
|
||
|
"__rlshift__": "Use << operator",
|
||
|
"__rrshift__": "Use >> operator",
|
||
|
"__rand__": "Use & operator",
|
||
|
"__rxor__": "Use ^ operator",
|
||
|
"__ror__": "Use | operator",
|
||
|
"__iadd__": "Use += operator",
|
||
|
"__isub__": "Use -= operator",
|
||
|
"__imul__": "Use *= operator",
|
||
|
"__imatmul__": "Use @= operator",
|
||
|
"__itruediv__": "Use /= operator",
|
||
|
"__ifloordiv__": "Use //= operator",
|
||
|
"__imod__": "Use %= operator",
|
||
|
"__ipow__": "Use **= operator",
|
||
|
"__ilshift__": "Use <<= operator",
|
||
|
"__irshift__": "Use >>= operator",
|
||
|
"__iand__": "Use &= operator",
|
||
|
"__ixor__": "Use ^= operator",
|
||
|
"__ior__": "Use |= operator",
|
||
|
"__neg__": "Multiply by -1 instead",
|
||
|
"__pos__": "Multiply by +1 instead",
|
||
|
"__abs__": "Use abs built-in function",
|
||
|
"__invert__": "Use ~ operator",
|
||
|
"__complex__": "Use complex built-in function",
|
||
|
"__int__": "Use int built-in function",
|
||
|
"__float__": "Use float built-in function",
|
||
|
"__index__": "Use index method",
|
||
|
"__round__": "Use round built-in function",
|
||
|
"__trunc__": "Use math.trunc function",
|
||
|
"__floor__": "Use math.floor function",
|
||
|
"__ceil__": "Use math.ceil function",
|
||
|
"__enter__": "Invoke context manager directly",
|
||
|
"__aiter__": "Use iter built-in function",
|
||
|
"__anext__": "Use next built-in function",
|
||
|
"__aenter__": "Invoke context manager directly",
|
||
|
"__copy__": "Use copy.copy function",
|
||
|
"__deepcopy__": "Use copy.deepcopy function",
|
||
|
"__fspath__": "Use os.fspath function instead",
|
||
|
}
|
||
|
name = "unnecessary-dunder-call"
|
||
|
priority = -1
|
||
|
msgs = {
|
||
|
"C2801": (
|
||
|
"Unnecessarily calls dunder method %s. %s.",
|
||
|
"unnecessary-dunder-call",
|
||
|
"Used when a dunder method is manually called instead "
|
||
|
"of using the corresponding function/method/operator.",
|
||
|
),
|
||
|
}
|
||
|
options = ()
|
||
|
|
||
|
def visit_call(self, node: nodes.Call) -> None:
|
||
|
"""Check if method being called is an unnecessary dunder method."""
|
||
|
if (
|
||
|
isinstance(node.func, nodes.Attribute)
|
||
|
and node.func.attrname in self.includedict
|
||
|
):
|
||
|
self.add_message(
|
||
|
"unnecessary-dunder-call",
|
||
|
node=node,
|
||
|
args=(node.func.attrname, self.includedict[node.func.attrname]),
|
||
|
confidence=HIGH,
|
||
|
)
|
||
|
|
||
|
|
||
|
def register(linter: "PyLinter") -> None:
|
||
|
linter.register_checker(DunderCallChecker(linter))
|