Module `rulebook-pylint.rulebook_pylint.unnecessary_blank_line_before_package`

Functions

def register(linter: PyLinter)

Expand source code

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

Classes

class UnnecessaryBlankLineBeforePackageChecker (linter: PyLinter)

Expand source code

class UnnecessaryBlankLineBeforePackageChecker(RulebookTokenChecker):
    """See detail: https://hanggrian.github.io/rulebook/rules/#unnecessary-blank-line-before-package"""
    MSG: str = 'unnecessary-blank-line-before-package'

    name: str = 'unnecessary-blank-line-before-package'
    msgs: dict[str, MessageDefinitionTuple] = Messages.of(MSG)

    def process_tokens(self, tokens: list[TokenInfo]) -> None:
        for token in tokens:
            # skip metadata
            type2: int = token.type
            if type2 == ENCODING:
                continue

            # checks for violation
            if type2 == NL:
                self.add_message(self.MSG, line=0)
            return

See detail: https://hanggrian.github.io/rulebook/rules/#unnecessary-blank-line-before-package

Checker instances should have the linter as argument.

Ancestors

rulebook_pylint.checkers.RulebookTokenChecker
pylint.checkers.base_checker.BaseTokenChecker
pylint.checkers.base_checker.BaseChecker
pylint.config.arguments_provider._ArgumentsProvider
abc.ABC

Class variables

var MSG : str: The type of the None singleton.
var msgs : dict[str, tuple[str, str, str] | tuple[str, str, str, pylint.typing.ExtraMessageOptions]]: The type of the None singleton.
var name : str: The type of the None singleton.

Methods

def process_tokens(self, tokens: list[tokenize.TokenInfo]) ‑> None

Expand source code

def process_tokens(self, tokens: list[TokenInfo]) -> None:
    for token in tokens:
        # skip metadata
        type2: int = token.type
        if type2 == ENCODING:
            continue

        # checks for violation
        if type2 == NL:
            self.add_message(self.MSG, line=0)
        return

Should be overridden by subclasses.