image-match/python/py/Lib/site-packages/pylint/checkers/newstyle.py

# 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

"""Check for new / old style related problems."""

from __future__ import annotations

from typing import TYPE_CHECKING

import astroid
from astroid import nodes

from pylint.checkers import BaseChecker
from pylint.checkers.utils import node_frame_class, only_required_for_messages
from pylint.typing import MessageDefinitionTuple

if TYPE_CHECKING:
    from pylint.lint import PyLinter

MSGS: dict[str, MessageDefinitionTuple] = {
    "E1003": (
        "Bad first argument %r given to super()",
        "bad-super-call",
        "Used when another argument than the current class is given as "
        "first argument of the super builtin.",
    )
}


class NewStyleConflictChecker(BaseChecker):
    """Checks for usage of new style capabilities on old style classes and
    other new/old styles conflicts problems.

    * use of property, __slots__, super
    * "super" usage
    """

    # configuration section name
    name = "newstyle"
    # messages
    msgs = MSGS
    # configuration options
    options = ()

    @only_required_for_messages("bad-super-call")
    def visit_functiondef(self, node: nodes.FunctionDef) -> None:
        """Check use of super."""
        # ignore actual functions or method within a new style class
        if not node.is_method():
            return
        klass = node.parent.frame()
        for stmt in node.nodes_of_class(nodes.Call):
            if node_frame_class(stmt) != node_frame_class(node):
                # Don't look down in other scopes.
                continue

            expr = stmt.func
            if not isinstance(expr, nodes.Attribute):
                continue

            match call := expr.expr:
                case nodes.Call(func=nodes.Name(name="super"), args=[arg0, *_]):
                    pass
                case _:
                    # skip the test if using super
                    # super first arg should not be the class
                    continue

            # calling super(type(self), self) can lead to recursion loop
            # in derived classes
            match arg0:
                case nodes.Call(func=nodes.Name(name="type")):
                    self.add_message("bad-super-call", node=call, args=("type",))
                    continue

            # calling super(self.__class__, self) can lead to recursion loop
            # in derived classes
            match call.args:
                case [
                    nodes.Attribute(attrname="__class__"),
                    nodes.Name(name="self"),
                    *_,
                ]:
                    self.add_message(
                        "bad-super-call", node=call, args=("self.__class__",)
                    )
                    continue

            try:
                supcls = call.args and next(call.args[0].infer(), None)
            except astroid.InferenceError:
                continue

            # If the supcls is in the ancestors of klass super can be used to skip
            # a step in the mro() and get a method from a higher parent
            if klass is not supcls and all(i != supcls for i in klass.ancestors()):
                name = None
                # if supcls is not Uninferable, then supcls was inferred
                # and use its name. Otherwise, try to look
                # for call.args[0].name
                if supcls:
                    name = supcls.name
                elif call.args and hasattr(call.args[0], "name"):
                    name = call.args[0].name
                if name:
                    self.add_message("bad-super-call", node=call, args=(name,))

    visit_asyncfunctiondef = visit_functiondef


def register(linter: PyLinter) -> None:
    linter.register_checker(NewStyleConflictChecker(linter))