Module rulebook-pylint.rulebook_pylint.checkers

Classes

class RulebookChecker (linter: PyLinter)
Expand source code
class RulebookChecker(BaseChecker):
    """Standard checker with `visit_` prefix functions."""

Standard checker with visit_ prefix functions.

Checker instances should have the linter as argument.

Ancestors

  • pylint.checkers.base_checker.BaseChecker
  • pylint.config.arguments_provider._ArgumentsProvider
class RulebookFileChecker (linter: PyLinter)
Expand source code
class RulebookFileChecker(BaseRawFileChecker, ABC):
    """Override `process_module` to capture file at once."""
    lines: list[bytes]

    def process_module(self, node: Module) -> None:
        with node.stream() as stream:
            self.lines = [s.strip() for s in stream.readlines()]

Override process_module to capture file at once.

Checker instances should have the linter as argument.

Ancestors

  • pylint.checkers.base_checker.BaseRawFileChecker
  • pylint.checkers.base_checker.BaseChecker
  • pylint.config.arguments_provider._ArgumentsProvider
  • abc.ABC

Class variables

var lines : list[bytes]

The type of the None singleton.

Methods

def process_module(self, node: astroid.nodes.scoped_nodes.scoped_nodes.Module) ‑> None
Expand source code
def process_module(self, node: Module) -> None:
    with node.stream() as stream:
        self.lines = [s.strip() for s in stream.readlines()]

Process a module.

The module's content is accessible via astroid.stream

class RulebookTokenChecker (linter: PyLinter)
Expand source code
class RulebookTokenChecker(BaseTokenChecker, ABC):
    """Override `process_tokens` to iterate each token."""

Override process_tokens to iterate each token.

Checker instances should have the linter as argument.

Ancestors

  • pylint.checkers.base_checker.BaseTokenChecker
  • pylint.checkers.base_checker.BaseChecker
  • pylint.config.arguments_provider._ArgumentsProvider
  • abc.ABC