pylint.testutils.configuration_test

module documentation
(source)

Utility functions for configuration testing.

Function get_expected_configuration Get the expected parsed configuration of a configuration functional test.
Function get_expected_or_default Return the expected value from the file if it exists, or the given default.
Function get_expected_output Get the expected output of a functional test.
Function get_related_files Return all the file related to a test conf file ending with a suffix.
Function run_using_a_configuration_file Simulate a run with a configuration without really launching the checks.
Constant EXPECTED_CONF_APPEND_KEY Undocumented
Constant EXPECTED_CONF_REMOVE_KEY Undocumented
Type Alias PylintConfiguration Undocumented
def get_expected_configuration(configuration_path: str, default_configuration: PylintConfiguration) -> PylintConfiguration: (source)

Get the expected parsed configuration of a configuration functional test.

def get_expected_or_default(tested_configuration_file: str|Path, suffix: str, default: str) -> str: (source)

Return the expected value from the file if it exists, or the given default.

def get_expected_output(configuration_path: str|Path, user_specific_path: Path) -> tuple[int, str]: (source)

Get the expected output of a functional test.

def get_related_files(tested_configuration_file: str|Path, suffix_filter: str) -> list[Path]: (source)

Return all the file related to a test conf file ending with a suffix.

def run_using_a_configuration_file(configuration_path: Path|str, file_to_lint: str = __file__) -> tuple[Mock, Mock, Run]: (source)

Simulate a run with a configuration without really launching the checks.

EXPECTED_CONF_APPEND_KEY: str = (source)

Undocumented

Value
'functional_append'
EXPECTED_CONF_REMOVE_KEY: str = (source)

Undocumented

Value
'functional_remove'
PylintConfiguration = (source)

Undocumented

Value
Dict[str, ConfigurationValue]