FM / testutils

/opt/imh-python/lib/python3.9/site-packages/pylint/testutils/

/opt/imh-python/lib/python3.9/site-packages/pylint/testutils

Name	Size	Mode	Actions
functional/	-	0755	rm
_primer/	-	0755	rm
__pycache__/	-	0755	rm
checker_test_case.py	3325	0644	edit dl rm
configuration_test.py	5416	0644	edit dl rm
constants.py	1159	0644	edit dl rm
decorator.py	1262	0644	edit dl rm
get_test_info.py	2137	0644	edit dl rm
global_test_linter.py	695	0644	edit dl rm
lint_module_test.py	12538	0644	edit dl rm
output_line.py	3994	0644	edit dl rm
pyreverse.py	4254	0644	edit dl rm
reporter_for_tests.py	2321	0644	edit dl rm
testing_pylintrc	264	0644	edit dl rm
tokenize_str.py	457	0644	edit dl rm
unittest_linter.py	2692	0644	edit dl rm
utils.py	3107	0644	edit dl rm
_run.py	1430	0644	edit dl rm
__init__.py	1319	0644	edit dl rm

Edit: /opt/imh-python/lib/python3.9/site-packages/pylint/testutils/checker_test_case.py (3325B)

from __future__ import annotations

import contextlib
from collections.abc import Generator, Iterator
from typing import Any

from astroid import nodes

from pylint.testutils.global_test_linter import linter
from pylint.testutils.output_line import MessageTest
from pylint.testutils.unittest_linter import UnittestLinter
from pylint.utils import ASTWalker

class CheckerTestCase:
    """A base testcase class for unit testing individual checker classes."""

# TODO: Figure out way to type this as type[BaseChecker] while also
    # setting self.checker correctly.
    CHECKER_CLASS: Any
    CONFIG: dict[str, Any] = {}

def setup_method(self) -> None:
        self.linter = UnittestLinter()
        self.checker = self.CHECKER_CLASS(self.linter)
        for key, value in self.CONFIG.items():
            setattr(self.checker.linter.config, key, value)
        self.checker.open()

@contextlib.contextmanager
    def assertNoMessages(self) -> Iterator[None]:
        """Assert that no messages are added by the given method."""
        with self.assertAddsMessages():
            yield

@contextlib.contextmanager
    def assertAddsMessages(
        self, *messages: MessageTest, ignore_position: bool = False
    ) -> Generator[None]:
        """Assert that exactly the given method adds the given messages.

The list of messages must exactly match *all* the messages added by the
        method. Additionally, we check to see whether the args in each message can
        actually be substituted into the message string.

Using the keyword argument `ignore_position`, all checks for position
        arguments (line, col_offset, ...) will be skipped. This can be used to
        just test messages for the correct node.
        """
        yield
        got = self.linter.release_messages()
        no_msg = "No message."
        expected = "\n".join(repr(m) for m in messages) or no_msg
        got_str = "\n".join(repr(m) for m in got) or no_msg
        msg = (
            "Expected messages did not match actual.\n"
            f"\nExpected:\n{expected}\n\nGot:\n{got_str}\n"
        )

assert len(messages) == len(got), msg

for expected_msg, gotten_msg in zip(messages, got):
            assert expected_msg.msg_id == gotten_msg.msg_id, msg
            assert expected_msg.node == gotten_msg.node, msg
            assert expected_msg.args == gotten_msg.args, msg
            assert expected_msg.confidence == gotten_msg.confidence, msg

if ignore_position:
                # Do not check for line, col_offset etc...
                continue

assert expected_msg.line == gotten_msg.line, msg
            assert expected_msg.col_offset == gotten_msg.col_offset, msg
            assert expected_msg.end_line == gotten_msg.end_line, msg
            assert expected_msg.end_col_offset == gotten_msg.end_col_offset, msg

def walk(self, node: nodes.NodeNG) -> None:
        """Recursive walk on the given node."""
        walker = ASTWalker(linter)
        walker.add_checker(self.checker)
        walker.walk(node)

# 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 from __future__ import annotations import contextlib from collections.abc import Generator, Iterator from typing import Any from astroid import nodes from pylint.testutils.global_test_linter import linter from pylint.testutils.output_line import MessageTest from pylint.testutils.unittest_linter import UnittestLinter from pylint.utils import ASTWalker class CheckerTestCase: """A base testcase class for unit testing individual checker classes.""" # TODO: Figure out way to type this as type[BaseChecker] while also # setting self.checker correctly. CHECKER_CLASS: Any CONFIG: dict[str, Any] = {} def setup_method(self) -> None: self.linter = UnittestLinter() self.checker = self.CHECKER_CLASS(self.linter) for key, value in self.CONFIG.items(): setattr(self.checker.linter.config, key, value) self.checker.open() @contextlib.contextmanager def assertNoMessages(self) -> Iterator[None]: """Assert that no messages are added by the given method.""" with self.assertAddsMessages(): yield @contextlib.contextmanager def assertAddsMessages( self, *messages: MessageTest, ignore_position: bool = False ) -> Generator[None]: """Assert that exactly the given method adds the given messages. The list of messages must exactly match *all* the messages added by the method. Additionally, we check to see whether the args in each message can actually be substituted into the message string. Using the keyword argument `ignore_position`, all checks for position arguments (line, col_offset, ...) will be skipped. This can be used to just test messages for the correct node. """ yield got = self.linter.release_messages() no_msg = "No message." expected = "\n".join(repr(m) for m in messages) or no_msg got_str = "\n".join(repr(m) for m in got) or no_msg msg = ( "Expected messages did not match actual.\n" f"\nExpected:\n{expected}\n\nGot:\n{got_str}\n" ) assert len(messages) == len(got), msg for expected_msg, gotten_msg in zip(messages, got): assert expected_msg.msg_id == gotten_msg.msg_id, msg assert expected_msg.node == gotten_msg.node, msg assert expected_msg.args == gotten_msg.args, msg assert expected_msg.confidence == gotten_msg.confidence, msg if ignore_position: # Do not check for line, col_offset etc... continue assert expected_msg.line == gotten_msg.line, msg assert expected_msg.col_offset == gotten_msg.col_offset, msg assert expected_msg.end_line == gotten_msg.end_line, msg assert expected_msg.end_col_offset == gotten_msg.end_col_offset, msg def walk(self, node: nodes.NodeNG) -> None: """Recursive walk on the given node.""" walker = ASTWalker(linter) walker.add_checker(self.checker) walker.walk(node)