6.2.11.7. ImportPylint

Run pylint and import its results

Runs the pylint linter and imports its messages as analysis violations.

pylint checks the Python files below cwd, skipping those its ignore and ignore-paths settings exclude. Each message becomes a violation with the provider option's value, pylint by default.

pylint discovers its configuration from the working directory, for example a .pylintrc or pyproject.toml. Set config_file to use a specific configuration file instead.

Possible Messages

This rule has no predefined messages.

Options

additional_args

additional_args : list[str] = []

Additional arguments for the tool. They are passed on unquoted and unfiltered.
 

check_returncode

check_returncode : bool = True

Whether a non-zero exit status of the tool fails the rule. Turn it off for tools that report findings through their exit status, as many linters do.

Independent of this option, a run that imports no violations while the tool exits non-zero fails: its results are indistinguishable from a run in which the tool found nothing.

 

config_file

config_file : bauhaus.analysis.config.PlainPath | None = None

pylint configuration file, relative to cwd, passed as --rcfile in place of the configuration pylint finds itself.
 

cwd

cwd : bauhaus.analysis.config.LayerRelativePath | None = None

Optional execution directory for the command.
 

encoding

encoding : str = 'utf-8'

The encoding of the output of the executed command. See also encoding_error_handler.
 

encoding_error_handler

encoding_error_handler

Type: EncodingErrorHandler

Default: 'IGNORE'

The strategy to handle encoding errors during processing of the output of the executed command.

  • STRICT: abort with on error on encoding errors,
  • IGNORE: ignore encoding errors (accepting data loss),
  • REPLACE: replace problematic code points with a question mark (?).
 

environment

environment : dict[str, str] = {}

Additional environment variables for the command. These entries are added to the inherited environment; existing entries are overwritten.
 

executable

executable : bauhaus.analysis.config.PlainPath | None = None

Path to the tool's executable. Unset, the tool is looked up on PATH.
 

Option Types

These types are used by options listed above:

EncodingErrorHandler

  • STRICT

  • IGNORE

  • REPLACE