kiwitcms/Kiwi

View on GitHub
kiwi_lint/nested_definition.py

Summary

Maintainability
A
0 mins
Test Coverage
# Copyright (c) 2019,2023 Alexander Todorov <atodorov@MrSenko.com>

# Licensed under the GPL 2.0: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html

import astroid
from pylint import checkers
from pylint.checkers import utils


class NestedDefinitionChecker(checkers.BaseChecker):
    name = "nested-definition-checker"

    msgs = {
        "E4491": (
            "Nested class definition found!",
            "nested-class-found",
            "Do not define classes inside other classes or functions!",
        ),
        "E4492": (
            "Nested function definition found!",
            "nested-function-found",
            "Do not define functions inside other functions!",
        ),
    }

    @utils.only_required_for_messages("nested-function-found")
    def visit_functiondef(self, node):
        if not isinstance(node.parent, (astroid.Module, astroid.ClassDef)):
            self.add_message("nested-function-found", node=node)

    @utils.only_required_for_messages("nested-class-found")
    def visit_classdef(self, node):
        if not isinstance(node.parent, astroid.Module) and node.name not in [
            "Meta",
            "Media",
        ]:
            self.add_message("nested-class-found", node=node)