glob_linters package#

Subpackages#

Submodules#

glob_linters.cli module#

Console script for glob_linters.

glob_linters.cli.lint(targets: dict[str, list[str]]) → None[source]#

Linting process

Parameters:

targets (dict[str, list[str]]) – Files as a list to be linted for each file suffix

glob_linters.cli.main() → int[source]#

Console script for glob_linters.

glob_linters.linters module#

Linters

class glob_linters.linters.Black(executable: str)[source]#

Bases: Linter

black linter

process_output() → None[source]#

Process output, since some linters print errors to stdout

set_config_file(filepath: str = '.github/linter-configs/.black') → None[source]#

Set configuration file

Parameters:

filepath (str, optional) – Path of configuration, by default .github/linter-configs/.clang-format

class glob_linters.linters.ClangFormat(executable: str)[source]#

Bases: Linter

clang-format linter

DEFAULT_CONFIG_FILE_PATH = '.clang-format'#
set_config_file(filepath: str = '.github/linter-configs/.clang-format') → None[source]#

Set configuration file

Parameters:

filepath (str, optional) – Path of configuration, by default .github/linter-configs/.clang-format

class glob_linters.linters.Cpplint(executable: str)[source]#

Bases: Linter

cpplint linter

DEFAULT_CONFIG_FILE_PATH = 'CPPLINT.cfg'#
set_config_file(filepath: str = '.github/linter-configs/CPPLINT.cfg') → None[source]#

Set configuration file

Parameters:

filepath (str, optional) – Path of configuration, by default .github/linter-configs/.clang-format

class glob_linters.linters.Flake8(executable: str)[source]#

Bases: Linter

flake8 linter

process_output() → None[source]#

Process output, since some linters print errors to stdout

set_config_file(filepath: str = '.github/linter-configs/.flake8') → None[source]#

Set configuration file

Parameters:

filepath (str, optional) – Path of configuration, by default .github/linter-configs/.clang-format

class glob_linters.linters.Isort(executable: str)[source]#

Bases: Linter

isort linter

process_output() → None[source]#

Process output, since some linters print errors to stdout

set_config_file(filepath: str = '.github/linter-configs/.isort.cfg') → None[source]#

Set configuration file

Parameters:

filepath (str, optional) – Path of configuration, by default .github/linter-configs/.clang-format

class glob_linters.linters.Linter(executable: str)[source]#

Bases: object

Linter parent class

lint(filename: str) → int[source]#

General linting method

Parameters:

filename (str) – File path to be linted

Returns:

Return code of the linter program

Return type:

int

process_output() → None[source]#

Process output, since some linters print errors to stdout

set_config_file(filepath: str) → None[source]#

Set configuration file

Parameters:

filepath (str, optional) – Path of configuration, by default .github/linter-configs/.clang-format

class glob_linters.linters.Mypy(executable: str)[source]#

Bases: Linter

mypy linter

process_output() → None[source]#

Process output, since some linters print errors to stdout

set_config_file(filepath: str = '.github/linter-configs/.mypy.ini') → None[source]#

Set configuration file

Parameters:

filepath (str, optional) – Path of configuration, by default .github/linter-configs/.clang-format

class glob_linters.linters.Pylint(executable: str)[source]#

Bases: Linter

pylint linter

process_output() → None[source]#

Process output, since some linters print errors to stdout

set_config_file(filepath: str = '.github/linter-configs/.pylintrc') → None[source]#

Set configuration file

Parameters:

filepath (str, optional) – Path of configuration, by default .github/linter-configs/.clang-format

Module contents#

Top-level package for glob-linters.