Skip to content

Human-readable formatter

Human readable formatter.

HumanReadableFormatter

Bases: Formatter

Formatter for human-readable messages in the terminal.

Source code in src/dbt_score/formatters/human_readable_formatter.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
class HumanReadableFormatter(Formatter):
    """Formatter for human-readable messages in the terminal."""

    indent = "    "
    label_ok = "\033[1;32mOK  \033[0m"
    label_warning = "\033[1;33mWARN\033[0m"
    label_error = "\033[1;31mERR \033[0m"

    def __init__(self, *args: Any, **kwargs: Any):
        """Instantiate formatter."""
        super().__init__(*args, **kwargs)
        self._failed_models: list[tuple[Model, Score]] = []

    @staticmethod
    def bold(text: str) -> str:
        """Return text in bold."""
        return f"\033[1m{text}\033[0m"

    def model_evaluated(
        self, model: Model, results: ModelResultsType, score: Score
    ) -> None:
        """Callback when a model has been evaluated."""
        if score.value < self._config.fail_any_model_under:
            self._failed_models.append((model, score))
        print(
            f"{score.badge} {self.bold(model.name)} (score: {round(score.value, 1)!s})"
        )
        for rule, result in results.items():
            if result is None:
                print(f"{self.indent}{self.label_ok} {rule.source()}")
            elif isinstance(result, RuleViolation):
                print(
                    f"{self.indent}{self.label_warning} "
                    f"({rule.severity.name.lower()}) {rule.source()}: {result.message}"
                )
            else:
                print(f"{self.indent}{self.label_error} {rule.source()}: {result!s}")
        print()

    def project_evaluated(self, score: Score) -> None:
        """Callback when a project has been evaluated."""
        print(f"Project score: {self.bold(str(round(score.value, 1)))} {score.badge}")

        if len(self._failed_models) > 0:
            print()
            print(
                f"Error: model score too low, fail_any_model_under = "
                f"{self._config.fail_any_model_under}"
            )
            for model, score in self._failed_models:
                print(f"Model {model.name} scored {round(score.value, 1)}")

        elif score.value < self._config.fail_project_under:
            print()
            print(
                f"Error: project score too low, fail_project_under = "
                f"{self._config.fail_project_under}"
            )

__init__(*args, **kwargs)

Instantiate formatter.

Source code in src/dbt_score/formatters/human_readable_formatter.py 
21
22
23
24
def __init__(self, *args: Any, **kwargs: Any):
    """Instantiate formatter."""
    super().__init__(*args, **kwargs)
    self._failed_models: list[tuple[Model, Score]] = []

bold(text) staticmethod

Return text in bold.

Source code in src/dbt_score/formatters/human_readable_formatter.py 
26
27
28
29
@staticmethod
def bold(text: str) -> str:
    """Return text in bold."""
    return f"\033[1m{text}\033[0m"

model_evaluated(model, results, score)

Callback when a model has been evaluated.

Source code in src/dbt_score/formatters/human_readable_formatter.py 
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
def model_evaluated(
    self, model: Model, results: ModelResultsType, score: Score
) -> None:
    """Callback when a model has been evaluated."""
    if score.value < self._config.fail_any_model_under:
        self._failed_models.append((model, score))
    print(
        f"{score.badge} {self.bold(model.name)} (score: {round(score.value, 1)!s})"
    )
    for rule, result in results.items():
        if result is None:
            print(f"{self.indent}{self.label_ok} {rule.source()}")
        elif isinstance(result, RuleViolation):
            print(
                f"{self.indent}{self.label_warning} "
                f"({rule.severity.name.lower()}) {rule.source()}: {result.message}"
            )
        else:
            print(f"{self.indent}{self.label_error} {rule.source()}: {result!s}")
    print()

project_evaluated(score)

Callback when a project has been evaluated.

Source code in src/dbt_score/formatters/human_readable_formatter.py 
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
def project_evaluated(self, score: Score) -> None:
    """Callback when a project has been evaluated."""
    print(f"Project score: {self.bold(str(round(score.value, 1)))} {score.badge}")

    if len(self._failed_models) > 0:
        print()
        print(
            f"Error: model score too low, fail_any_model_under = "
            f"{self._config.fail_any_model_under}"
        )
        for model, score in self._failed_models:
            print(f"Model {model.name} scored {round(score.value, 1)}")

    elif score.value < self._config.fail_project_under:
        print()
        print(
            f"Error: project score too low, fail_project_under = "
            f"{self._config.fail_project_under}"
        )