Configuration

class Config

Materialized configuration valid for processing a single file.

path: Path

root: Path

excluded: bool = False

enable_root_import: bool | Path = False

enable: list[QualifiedRule | RuleNameSelector]

disable: list[QualifiedRule | RuleNameSelector]

rule_imports: list[QualifiedRule | RuleNameSelector]

options: dict[str, dict[str, str | int | float | bool | list[Any] | dict[str, Any]]]

python_version: Version | None

tags: Tags

formatter: str | None = 'auto'

output_format: OutputFormat = 'rattle'

output_template: str = ''

class Options

Command-line options to affect runtime behavior.

debug: bool | None = None

config_file: Path | None = None

exclude: Sequence[str] = ()

extend_exclude: Sequence[str] = ()

jobs: int | None = None

tags: Tags | None = None

rules: Sequence[QualifiedRule | RuleNameSelector] = ()

output_format: OutputFormat | None = None

output_template: str | None = None

print_metrics: bool = False

no_format: bool = False

class QualifiedRule

QualifiedRule(module: str, name: str | None = None, local: str | None = None, root: pathlib.Path | None = None)

module: str

name: str | None = None

local: str | None = None

root: Path | None = None

class RuleNameSelector

RuleNameSelector(value: str)

value: str

class Tags

Tags(include: tuple[str, …] = (), exclude: tuple[str, …] = ())

include: tuple[str, ...] = ()

exclude: tuple[str, ...] = ()

static parse(value)