solitude.linter module

class solitude.linter.Linter(executable: str, plugins: List[str], rules: dict, parallelism: int = 4)[source]

Bases: object

The linter object allows linting groups of contracts.

__init__(executable: str, plugins: List[str], rules: dict, parallelism: int = 4)[source]

Create a Linter

Parameters:
  • executable – path to the solium executable file
  • plugins – list of solium plugins
  • rules – dictionary containing solium rules
  • parallelism – maximum number of parallel instances to be run
lint(sourcelist: solitude.common.contract_sourcelist.ContractSourceList) → Iterator[Tuple[str, solitude.common.structures.FileMessage]][source]

Lint a group of contracts

Parameters:sourcelist – source files to lint, as ContractSourceList
Returns:an iterator of FileMessage objects containing the linter output information