sqlmesh.core.config.linter

 1from __future__ import annotations
 2
 3import typing as t
 4
 5from sqlglot import exp
 6from sqlglot.helper import ensure_collection
 7
 8from sqlmesh.core.config.base import BaseConfig
 9
10from sqlmesh.utils.pydantic import field_validator
11
12
13class LinterConfig(BaseConfig):
14    """Configuration for model linting
15
16    Args:
17        enabled: Flag indicating whether the linter should run
18
19        use_project_index: Whether to use the persistent project index when linting.
20
21        rules: A list of error rules to be applied on model
22        warn_rules: A list of rules to be applied on models but produce warnings instead of raising errors.
23        ignored_rules: A list of rules to be excluded/ignored
24
25    """
26
27    enabled: bool = False
28    use_project_index: bool = False
29
30    rules: t.Set[str] = set()
31    warn_rules: t.Set[str] = set()
32    ignored_rules: t.Set[str] = set()
33
34    @classmethod
35    def _validate_rules(cls, v: t.Any) -> t.Set[str]:
36        if isinstance(v, exp.Paren):
37            v = v.unnest().name
38        elif isinstance(v, (exp.Tuple, exp.Array)):
39            v = [e.name for e in v.expressions]
40        elif isinstance(v, exp.Expr):
41            v = v.name
42
43        return {name.lower() for name in ensure_collection(v)}
44
45    @field_validator("rules", "warn_rules", "ignored_rules", mode="before")
46    def rules_validator(cls, vs: t.Any) -> t.Set[str]:
47        return cls._validate_rules(vs)