Server : Apache System : Linux indy02.toastserver.com 3.10.0-962.3.2.lve1.5.85.el7.x86_64 #1 SMP Thu Apr 18 15:18:36 UTC 2024 x86_64 User : palandch ( 1163) PHP Version : 7.1.33 Disable Function : NONE Directory :  /opt/cloudlinux/venv/lib64/python3.11/site-packages/pylint_django/checkers/

Upload File : current_dir [ Writeable ] document_root [ Writeable ]

"""Models."""
from astroid.nodes import Assign, AssignName, ClassDef
from pylint.checkers import BaseChecker
from pylint.checkers.utils import check_messages
from pylint.interfaces import IAstroidChecker

from pylint_django.__pkginfo__ import BASE_ID
from pylint_django.utils import node_is_subclass


def _get_child_meta(node):
    for child in node.get_children():
        if isinstance(child, ClassDef) and child.name == "Meta":
            return child
    return None


class FormChecker(BaseChecker):
    """Django model checker."""

    __implements__ = IAstroidChecker

    name = "django-form-checker"
    msgs = {
        f"W{BASE_ID}04": (
            "Use explicit fields instead of exclude in ModelForm",
            "modelform-uses-exclude",
            "Prevents accidentally allowing users to set fields, especially when adding new fields to a Model",
        )
    }

    @check_messages("modelform-uses-exclude")
    def visit_classdef(self, node):
        """Class visitor."""
        if not node_is_subclass(node, "django.forms.models.ModelForm", ".ModelForm"):
            # we only care about forms
            return

        meta = _get_child_meta(node)

        if not meta:
            return

        for child in meta.get_children():
            if not isinstance(child, Assign) or not isinstance(child.targets[0], AssignName):
                continue

            if child.targets[0].name == "exclude":
                self.add_message(f"W{BASE_ID}04", node=child)
                break