Chore: Refine environment statements cli output

Author: themisvaltinos

sqlmesh/core/console.py

@@ -282,6 +282,7 @@ def show_model_difference_summary(
         environment_naming_info: EnvironmentNamingInfo,
         default_catalog: t.Optional[str],
         no_diff: bool = True,
+        show_environment_statements: bool = True,
     ) -> None:
         """Displays a summary of differences for the given models."""
 
@@ -555,6 +556,7 @@ def show_model_difference_summary(
         environment_naming_info: EnvironmentNamingInfo,
         default_catalog: t.Optional[str],
         no_diff: bool = True,
+        show_environment_statements: bool = True,
         ignored_snapshot_ids: t.Optional[t.Set[SnapshotId]] = None,
     ) -> None:
         pass
@@ -1270,6 +1272,7 @@ def show_model_difference_summary(
         environment_naming_info: EnvironmentNamingInfo,
         default_catalog: t.Optional[str],
         no_diff: bool = True,
+        show_environment_statements: bool = True,
     ) -> None:
         """Shows a summary of the differences.
 
@@ -1312,9 +1315,11 @@ def show_model_difference_summary(
         if context_diff.has_requirement_changes:
             self._print(f"[bold]Requirements:\n{context_diff.requirements_diff()}")
 
-        if context_diff.has_environment_statements_changes:
+        if context_diff.has_environment_statements_changes and show_environment_statements:
             self._print("[bold]Environment statements:\n")
-            for type, diff in context_diff.environment_statements_diff():
+            for type, diff in context_diff.environment_statements_diff(
+                include_python_env=not context_diff.is_new_environment
+            ):
                 self._print(Syntax(diff, type, line_numbers=False))
 
         self._show_summary_tree_for(
@@ -1496,6 +1501,7 @@ def _prompt_categorize(
             plan.context_diff,
             plan.environment_naming_info,
             default_catalog=default_catalog,
+            show_environment_statements=not no_diff,
         )
 
         if not no_diff:
@@ -2443,6 +2449,7 @@ def show_model_difference_summary(
         environment_naming_info: EnvironmentNamingInfo,
         default_catalog: t.Optional[str],
         no_diff: bool = True,
+        show_environment_statements: bool = True,
     ) -> None:
         """Shows a summary of the differences.
 
@@ -2468,9 +2475,11 @@ def show_model_difference_summary(
         if context_diff.has_requirement_changes:
             self._print(f"Requirements:\n{context_diff.requirements_diff()}")
 
-        if context_diff.has_environment_statements_changes:
+        if context_diff.has_environment_statements_changes and show_environment_statements:
             self._print("[bold]Environment statements:\n")
-            for _, diff in context_diff.environment_statements_diff():
+            for _, diff in context_diff.environment_statements_diff(
+                include_python_env=not context_diff.is_new_environment
+            ):
                 self._print(diff)
 
         added_snapshots = {context_diff.snapshots[s_id] for s_id in context_diff.added}
@@ -2977,15 +2986,18 @@ def show_model_difference_summary(
         environment_naming_info: EnvironmentNamingInfo,
         default_catalog: t.Optional[str],
         no_diff: bool = True,
+        show_environment_statements: bool = True,
     ) -> None:
         self._write("Model Difference Summary:")
 
         if context_diff.has_requirement_changes:
             self._write(f"Requirements:\n{context_diff.requirements_diff()}")
 
-        if context_diff.has_environment_statements_changes:
+        if context_diff.has_environment_statements_changes and show_environment_statements:
             self._write("Environment statements:\n")
-            for _, diff in context_diff.environment_statements_diff():
+            for _, diff in context_diff.environment_statements_diff(
+                include_python_env=not context_diff.is_new_environment
+            ):
                 self._write(diff)
 
         for added in context_diff.new_snapshots:

sqlmesh/core/context.py

@@ -1543,6 +1543,7 @@ def diff(self, environment: t.Optional[str] = None, detailed: bool = False) -> b
             ),
             self.default_catalog,
             no_diff=not detailed,
+            show_environment_statements=detailed,
         )
         return context_diff.has_changes
 

sqlmesh/core/context_diff.py

@@ -14,7 +14,7 @@
 
 import sys
 import typing as t
-from difflib import ndiff
+from difflib import ndiff, unified_diff
 from functools import cached_property
 from sqlmesh.core import constants as c
 from sqlmesh.core.console import get_console
@@ -341,16 +341,19 @@ def requirements_diff(self) -> str:
             )
         )
 
-    def environment_statements_diff(self) -> t.List[t.Tuple[str, str]]:
+    def environment_statements_diff(
+        self, include_python_env: bool = False
+    ) -> t.List[t.Tuple[str, str]]:
         def extract_statements(statements: t.List[EnvironmentStatements], attr: str) -> t.List[str]:
             return [
-                expr
+                string
                 for statement in statements
                 for expr in (
                     sorted_python_env_payloads(statement.python_env)
                     if attr == "python_env"
                     else getattr(statement, attr)
                 )
+                for string in expr.split("\n")
             ]
 
         def compute_diff(attribute: str) -> t.Optional[t.Tuple[str, str]]:
@@ -360,21 +363,24 @@ def compute_diff(attribute: str) -> t.Optional[t.Tuple[str, str]]:
             if previous == current:
                 return None
 
-            diff_lines = list(ndiff(previous, current))
             diff_text = attribute if not attribute == "python_env" else "dependencies"
             diff_text += ":\n"
+            if attribute == "python_env":
+                diff = list(unified_diff(previous, current))
+                diff_text += "\n".join(diff[2:] if len(diff) > 1 else diff)
+                return "python", diff_text + "\n"
 
+            diff_lines = list(ndiff(previous, current))
             if any(line.startswith(("-", "+")) for line in diff_lines):
                 diff_text += "  " + "\n  ".join(diff_lines) + "\n"
-
-            return "python" if attribute == "python_env" else "sql", diff_text
+            return "sql", diff_text
 
         return [
             diff
             for attribute in [
                 RuntimeStage.BEFORE_ALL.value,
                 RuntimeStage.AFTER_ALL.value,
-                "python_env",
+                *(["python_env"] if include_python_env else []),
             ]
             if (diff := compute_diff(attribute)) is not None
         ]

sqlmesh/integrations/github/cicd/controller.py

@@ -462,6 +462,7 @@ def get_plan_summary(self, plan: Plan) -> str:
                 environment_naming_info=plan.environment_naming_info,
                 default_catalog=self._context.default_catalog,
                 no_diff=False,
+                show_environment_statements=True,
             )
             difference_summary = self._console.consume_captured_output()
             self._console._show_missing_dates(plan, self._context.default_catalog)

tests/core/test_plan.py

@@ -3023,15 +3023,33 @@ def test_plan_environment_statements_diff(make_snapshot):
         terminal_console._print(diff)
     output = console_output.getvalue()
     stripped = strip_ansi_codes(output)
+
+    expected_output = (
+        "before_all:\n"
+        "  + CREATE OR REPLACE TABLE table_1 AS SELECT 1\n"
+        "  + @test_macro()\n\n"
+        "after_all:\n"
+        "  + CREATE OR REPLACE TABLE table_2 AS SELECT 2"
+    )
+    assert stripped == expected_output
+    console_output.close()
+
+    # Validate with python env included
+    console_output, terminal_console = create_test_console()
+    for _, diff in context_diff.environment_statements_diff(include_python_env=True):
+        terminal_console._print(diff)
+    output = console_output.getvalue()
+    stripped = strip_ansi_codes(output)
     expected_output = (
         "before_all:\n"
         "  + CREATE OR REPLACE TABLE table_1 AS SELECT 1\n"
         "  + @test_macro()\n\n"
         "after_all:\n"
         "  + CREATE OR REPLACE TABLE table_2 AS SELECT 2\n\n"
         "dependencies:\n"
-        "  + def test_macro(evaluator):\n"
-        "    return 'one'"
+        "@@ -0,0 +1,2 @@\n\n"
+        "+def test_macro(evaluator):\n"
+        "+    return 'one'"
     )
     assert stripped == expected_output
     console_output.close()