glob_linters.utils package

Submodules

glob_linters.utils.io module

IO functions

glob_linters.utils.io.print_configs() → None

Show configuration

glob_linters.utils.io.scan(target_dirs: list[str], suffixes: list[str]) → dict[str, list[str]]

Scan directories to obtain target files

Parameters:

• target_dirs (list[str]) – Directories to be scanned

• suffix (list[str]) – Expected file suffix

Returns:

Absolute paths of target files

Return type:

dict[str, list[str]]

glob_linters.utils.settings module

Configuration

class glob_linters.utils.settings.Configs

Bases: object

Class to store configs/settings

available_configs: ClassVar[dict[str, list[str]]] = {'.cpp': ['enabled_linters', 'disabled_linters'], '.cpp:clang_format': ['executable', 'options', 'config_file'], '.cpp:cpplint': ['executable', 'options', 'config_file'], '.py': ['enabled_linters', 'disabled_linters'], '.py:black': ['executable', 'options', 'config_file'], '.py:flake8': ['executable', 'options', 'config_file'], '.py:isort': ['executable', 'options', 'config_file'], '.py:mypy': ['executable', 'options', 'config_file'], '.py:pylint': ['executable', 'options', 'config_file'], 'DEFAULT': [], 'env': ['debug', 'extra_python_package_requirements'], 'target': ['dirs', 'suffixes']}

available_suffix_linters: ClassVar[list[str]] = ['.cpp:cpplint', '.cpp:clang_format', '.py:pylint', '.py:flake8', '.py:black', '.py:isort', '.py:mypy']

black: ClassVar[Black] = <glob_linters.linters.Black object>

clang_format: ClassVar[ClangFormat] = <glob_linters.linters.ClangFormat object>

cpplint: ClassVar[Cpplint] = <glob_linters.linters.Cpplint object>

debug: ClassVar[bool] = False

flake8: ClassVar[Flake8] = <glob_linters.linters.Flake8 object>

has_read_config_file: ClassVar[bool] = False

isort: ClassVar[Isort] = <glob_linters.linters.Isort object>

linters_enabled: ClassVar[dict[str, list[str]]] = {'.cpp': ['cpplint', 'clang_format'], '.py': ['pylint', 'flake8', 'black', 'isort', 'mypy']}

mypy: ClassVar[Mypy] = <glob_linters.linters.Mypy object>

pylint: ClassVar[Pylint] = <glob_linters.linters.Pylint object>

return_code: ClassVar[int] = 0

target_dirs: ClassVar[list[str]] = ['.']

target_suffixes: ClassVar[list[str]] = ['.cpp', '.py']

glob_linters.utils.settings.parse_args(args: Namespace) → None

Parse command line arguments

Parameters:

args (argparse.Namespace) – Arguments returned by argparse.parse_args

Raises:

ValueError – Invalid linter name found

glob_linters.utils.settings.parse_config_file(config_file: str) → None

Parse configuration from configparser-like file

Parameters:

config_file (str) – Configuration file path

Raises:

ValueError – Invalid section/option found in config file

Module contents