Skip to content

Config

This module is responsible for loading configuration.

Badge dataclass

Badge object.

Source code in src/dbt_score/config.py 
21
22
23
24
25
26
@dataclass
class Badge:
    """Badge object."""

    icon: str
    threshold: float

BadgeConfig dataclass

Configuration for badges.

Source code in src/dbt_score/config.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
@dataclass
class BadgeConfig:
    """Configuration for badges."""

    third: Badge = field(default_factory=lambda: Badge("🥉", 6.0))
    second: Badge = field(default_factory=lambda: Badge("🥈", 8.0))
    first: Badge = field(default_factory=lambda: Badge("🥇", 10.0))
    wip: Badge = field(default_factory=lambda: Badge("🚧", 0.0))

    def validate(self) -> None:
        """Validate the badge configuration."""
        if not (self.first.threshold > self.second.threshold > self.third.threshold):
            raise ValueError("Invalid badge thresholds.")
        if self.first.threshold > 10.0:  # noqa: PLR2004 [magic-value-comparison]
            raise ValueError("first threshold must 10.0 or lower.")
        if self.third.threshold < 0.0:
            raise ValueError("third threshold must be 0.0 or higher.")
        if self.wip.threshold != 0.0:
            raise AttributeError("wip badge cannot have a threshold configuration.")

validate()

Validate the badge configuration.

Source code in src/dbt_score/config.py 
38
39
40
41
42
43
44
45
46
47
def validate(self) -> None:
    """Validate the badge configuration."""
    if not (self.first.threshold > self.second.threshold > self.third.threshold):
        raise ValueError("Invalid badge thresholds.")
    if self.first.threshold > 10.0:  # noqa: PLR2004 [magic-value-comparison]
        raise ValueError("first threshold must 10.0 or lower.")
    if self.third.threshold < 0.0:
        raise ValueError("third threshold must be 0.0 or higher.")
    if self.wip.threshold != 0.0:
        raise AttributeError("wip badge cannot have a threshold configuration.")

Config

Configuration for dbt-score.

Source code in src/dbt_score/config.py 
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
class Config:
    """Configuration for dbt-score."""

    _main_section: Final[str] = "tool.dbt-score"
    _options: Final[list[str]] = [
        "rule_namespaces",
        "disabled_rules",
        "inject_cwd_in_python_path",
        "fail_project_under",
        "fail_any_item_under",
        "show",
    ]
    _rules_section: Final[str] = "rules"
    _badges_section: Final[str] = "badges"

    def __init__(self) -> None:
        """Initialize the Config object."""
        self.rule_namespaces: list[str] = ["dbt_score.rules", "dbt_score_rules"]
        self.disabled_rules: list[str] = []
        self.inject_cwd_in_python_path = True
        self.rules_config: dict[str, RuleConfig] = {}
        self.config_file: Path | None = None
        self.badge_config: BadgeConfig = BadgeConfig()
        self.fail_project_under: float = 5.0
        self.fail_any_item_under: float = 5.0
        self.show: str = "failing-rules"

    def set_option(self, option: str, value: Any) -> None:
        """Set an option in the config."""
        setattr(self, option, value)

    def _load_toml_file(self, file: str) -> None:
        """Load the options from a TOML file."""
        with open(file, "rb") as f:
            toml_data = tomllib.load(f)

        tools = toml_data.get("tool", {})
        dbt_score_config = tools.get("dbt-score", {})
        rules_config = dbt_score_config.pop(self._rules_section, {})
        badge_config = dbt_score_config.pop(self._badges_section, {})

        # Main configuration
        for option, value in dbt_score_config.items():
            if option in self._options:
                self.set_option(option, value)
            elif not isinstance(
                value, dict
            ):  # If value is a dictionary, it's another section
                logger.warning(
                    f"Option {option} in {self._main_section} not supported."
                )

        # Badge configuration
        for name, config in badge_config.items():
            try:
                default_config = getattr(self.badge_config, name)
                updated_config = replace(default_config, **config)
                setattr(self.badge_config, name, updated_config)
            except AttributeError as e:
                options = list(BadgeConfig.__annotations__.keys())
                raise AttributeError(f"Config only accepts badges: {options}.") from e
            except TypeError as e:
                options = list(Badge.__annotations__.keys())
                if name == "wip":
                    options.remove("threshold")
                raise AttributeError(
                    f"Badge {name}: config only accepts {options}."
                ) from e

        self.badge_config.validate()

        # Rule configuration
        self.rules_config = {
            name: RuleConfig.from_dict(config) for name, config in rules_config.items()
        }

    @staticmethod
    def get_config_file(directory: Path) -> Path | None:
        """Get the config file."""
        candidates = [directory]
        candidates.extend(directory.parents)
        for path in candidates:
            config_file = path / DEFAULT_CONFIG_FILE
            if config_file.exists():
                return config_file

    def load(self) -> None:
        """Load the config."""
        config_file = self.get_config_file(Path.cwd())
        if config_file:
            self._load_toml_file(str(config_file))

    def overload(self, values: dict[str, Any]) -> None:
        """Overload config with additional values."""
        for key, value in values.items():
            self.set_option(key, value)

__init__()

Initialize the Config object.

Source code in src/dbt_score/config.py 
65
66
67
68
69
70
71
72
73
74
75
def __init__(self) -> None:
    """Initialize the Config object."""
    self.rule_namespaces: list[str] = ["dbt_score.rules", "dbt_score_rules"]
    self.disabled_rules: list[str] = []
    self.inject_cwd_in_python_path = True
    self.rules_config: dict[str, RuleConfig] = {}
    self.config_file: Path | None = None
    self.badge_config: BadgeConfig = BadgeConfig()
    self.fail_project_under: float = 5.0
    self.fail_any_item_under: float = 5.0
    self.show: str = "failing-rules"

get_config_file(directory) staticmethod

Get the config file.

Source code in src/dbt_score/config.py 
126
127
128
129
130
131
132
133
134
@staticmethod
def get_config_file(directory: Path) -> Path | None:
    """Get the config file."""
    candidates = [directory]
    candidates.extend(directory.parents)
    for path in candidates:
        config_file = path / DEFAULT_CONFIG_FILE
        if config_file.exists():
            return config_file

load()

Load the config.

Source code in src/dbt_score/config.py 
136
137
138
139
140
def load(self) -> None:
    """Load the config."""
    config_file = self.get_config_file(Path.cwd())
    if config_file:
        self._load_toml_file(str(config_file))

overload(values)

Overload config with additional values.

Source code in src/dbt_score/config.py 
142
143
144
145
def overload(self, values: dict[str, Any]) -> None:
    """Overload config with additional values."""
    for key, value in values.items():
        self.set_option(key, value)

set_option(option, value)

Set an option in the config.

Source code in src/dbt_score/config.py 
77
78
79
def set_option(self, option: str, value: Any) -> None:
    """Set an option in the config."""
    setattr(self, option, value)