Skip to content

JSON formatter

JSON formatter.

Shape of the JSON output:

{
    "evaluables": {
        "model_foo": {
            "score": 5.0,
            "badge": "🥈",
            "pass": true,
            "results": {
                "rule1": {
                    "result": "OK",
                    "severity": null
                    "message": null
                },
                "rule2": {
                    "result": "WARN",
                    "severity": "medium",
                    "message": "Model lacks a description."
                }
            ]
        },
        "model_bar": {
            "score": 0.0,
            "badge": "🥉",
            "pass": false,
            "results": {
                "rule1": {
                    "result": "ERR",
                    "message": "Exception message"
                }
            }
        }
    },
    "project": {
        "score": 2.5,
        "badge": "🥉",
        "pass": false
    }
}

JSONFormatter

Bases: Formatter

Formatter for JSON output.

Source code in src/dbt_score/formatters/json_formatter.py 
 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
class JSONFormatter(Formatter):
    """Formatter for JSON output."""

    def __init__(self, *args: Any, **kwargs: Any):
        """Instantiate formatter."""
        super().__init__(*args, **kwargs)
        self.evaluable_results: dict[str, dict[str, Any]] = {}
        self._project_results: dict[str, Any]

    def evaluable_evaluated(
        self, evaluable: Evaluable, results: EvaluableResultsType, score: Score
    ) -> None:
        """Callback when an evaluable item has been evaluated."""
        self.evaluable_results[evaluable.name] = {
            "score": score.value,
            "badge": score.badge,
            "pass": score.value >= self._config.fail_any_item_under,
            "results": {},
        }
        for rule, result in results.items():
            severity = rule.severity.name.lower()
            if result is None:
                self.evaluable_results[evaluable.name]["results"][rule.source()] = {
                    "result": "OK",
                    "severity": severity,
                    "message": None,
                }
            elif isinstance(result, RuleViolation):
                self.evaluable_results[evaluable.name]["results"][rule.source()] = {
                    "result": "WARN",
                    "severity": severity,
                    "message": result.message,
                }
            else:
                self.evaluable_results[evaluable.name]["results"][rule.source()] = {
                    "result": "ERR",
                    "severity": severity,
                    "message": str(result),
                }

    def project_evaluated(self, score: Score) -> None:
        """Callback when a project has been evaluated."""
        self._project_results = {
            "score": score.value,
            "badge": score.badge,
            "pass": score.value >= self._config.fail_project_under,
        }
        document = {
            "evaluables": self.evaluable_results,
            "project": self._project_results,
        }
        print(json.dumps(document, indent=2, ensure_ascii=False))

__init__(*args, **kwargs)

Instantiate formatter.

Source code in src/dbt_score/formatters/json_formatter.py 
60
61
62
63
64
def __init__(self, *args: Any, **kwargs: Any):
    """Instantiate formatter."""
    super().__init__(*args, **kwargs)
    self.evaluable_results: dict[str, dict[str, Any]] = {}
    self._project_results: dict[str, Any]

evaluable_evaluated(evaluable, results, score)

Callback when an evaluable item has been evaluated.

Source code in src/dbt_score/formatters/json_formatter.py 
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
def evaluable_evaluated(
    self, evaluable: Evaluable, results: EvaluableResultsType, score: Score
) -> None:
    """Callback when an evaluable item has been evaluated."""
    self.evaluable_results[evaluable.name] = {
        "score": score.value,
        "badge": score.badge,
        "pass": score.value >= self._config.fail_any_item_under,
        "results": {},
    }
    for rule, result in results.items():
        severity = rule.severity.name.lower()
        if result is None:
            self.evaluable_results[evaluable.name]["results"][rule.source()] = {
                "result": "OK",
                "severity": severity,
                "message": None,
            }
        elif isinstance(result, RuleViolation):
            self.evaluable_results[evaluable.name]["results"][rule.source()] = {
                "result": "WARN",
                "severity": severity,
                "message": result.message,
            }
        else:
            self.evaluable_results[evaluable.name]["results"][rule.source()] = {
                "result": "ERR",
                "severity": severity,
                "message": str(result),
            }

project_evaluated(score)

Callback when a project has been evaluated.

Source code in src/dbt_score/formatters/json_formatter.py 
 97
 98
 99
100
101
102
103
104
105
106
107
108
def project_evaluated(self, score: Score) -> None:
    """Callback when a project has been evaluated."""
    self._project_results = {
        "score": score.value,
        "badge": score.badge,
        "pass": score.value >= self._config.fail_project_under,
    }
    document = {
        "evaluables": self.evaluable_results,
        "project": self._project_results,
    }
    print(json.dumps(document, indent=2, ensure_ascii=False))