dwh_auditor.reporter — 監査結果の出力・レポート生成層¶
dwh_auditor.reporter パッケージは、Analyzer が生成した AuditResult オブジェクトを
ユーザーが参照しやすい形式（ターミナル / Markdown ファイル）に整形して出力します。
コンソール出力 (reporter.console)¶
Rich ライブラリを使って、 カラー付きのテーブル形式でターミナルに出力します。
使用例:
from dwh_auditor.reporter.console import print_to_console
from dwh_auditor.models.result import AuditResult
result: AuditResult = ... # Received from Analyzer
print_to_console(result)
コンソール出力層 (Rich を使ったリッチな CLI 出力).
- dwh_auditor.reporter.console.print_to_console(result)[ソース]¶
AuditResult をターミナルにリッチ表示する.
- パラメータ:
result (AuditResult) -- Analyzer から受け取った監査結果
- 戻り値の型:
None
Markdown レポート生成 (reporter.markdown)¶
report.md を生成します。
CI/CD パイプラインの Artifact として保存したり、
社内 Wiki に自動投稿するのに適した形式です。
使用例:
from dwh_auditor.reporter.markdown import generate_markdown_report
generate_markdown_report(result, filepath="audit_report.md")
Markdown レポート生成層.
- dwh_auditor.reporter.markdown.generate_markdown_report(result, filepath='report.md')[ソース]¶
AuditResult を Markdown 形式のレポートファイルとして出力する.
CI/CD の Artifact として保存したり、社内 Wiki に貼り付けることを想定しています。 末尾にビジネス導線を含みます。
- パラメータ:
result (AuditResult) -- Analyzer から受け取った監査結果
filepath (str) -- 出力先ファイルパス (デフォルト: "report.md")
- 戻り値の型:
None
JSON レポート生成 (reporter.json_out)¶
システム連携・二次解析用の JSON 形式で監査結果を出力します。 jq 等でのパースや、ダッシュボードへの直接取り込みに適しています。
使用例:
from dwh_auditor.reporter.json_out import generate_json_report
json_str = generate_json_report(result)
print(json_str)
JSON フォーマットの出力層.
- dwh_auditor.reporter.json_out.generate_json_report(result)[ソース]¶
AuditResult を JSON 文字列に変換する.
CI/CD ツール等での利用を想定し、標準出力にそのまま渡せる形式で出力する。
- パラメータ:
result (AuditResult)
- 戻り値の型: