Added --diff option to CLI

Author: jgelens

pyinfra/api/config.py

@@ -53,6 +53,7 @@ class ConfigDefaults:
     IGNORE_ERRORS: bool = False
     # Shell to use to execute commands
     SHELL: str = "sh"
+    DIFF: bool = False
 
 
 config_defaults = {key: value for key, value in ConfigDefaults.__dict__.items() if key.isupper()}

pyinfra/operations/files.py

@@ -1033,21 +1033,22 @@ def put(
     # File exists, check sum and check user/group/mode/atime/mtime if supplied
     else:
         if not _file_equal(local_sum_path, dest):
-            # Generate diff when contents change
-            current_contents = host.get_fact(FileContents, path=dest)
-            if current_contents:
-                current_lines = [line + "\n" for line in current_contents]
-            else:
-                current_lines = []
+            if state.config.DIFF: 
+                # Generate diff when contents change
+                current_contents = host.get_fact(FileContents, path=dest)
+                if current_contents:
+                    current_lines = [line + "\n" for line in current_contents]
+                else:
+                    current_lines = []
 
-            logger.info(f"\n    Will modify {click.style(dest, bold=True)}")
+                logger.info(f"\n    Will modify {click.style(dest, bold=True)}")
 
-            with get_file_io(src, "r") as f:
-                desired_lines = f.readlines()
+                with get_file_io(src, "r") as f:
+                    desired_lines = f.readlines()
 
-            for line in generate_color_diff(current_lines, desired_lines):
-                logger.info(f"  {line}")
-            logger.info("")
+                for line in generate_color_diff(current_lines, desired_lines):
+                    logger.info(f"  {line}")
+                logger.info("")
 
             yield FileUploadCommand(
                 local_file,

pyinfra_cli/main.py

@@ -67,6 +67,12 @@ def _print_support(ctx, param, value):
     default=False,
     help="Don't execute operations on the target hosts.",
 )
+@click.option(
+    "--diff",
+    is_flag=True,
+    default=False,
+    help="Show the differences when changing text files and templates.",
+)
 @click.option(
     "-y",
     "--yes",
@@ -267,6 +273,7 @@ def _main(
     group_data,
     config_filename: str,
     dry: bool,
+    diff: bool,
     yes: bool,
     limit: Iterable,
     no_wait: bool,
@@ -310,6 +317,7 @@ def _main(
         shell_executable,
         fail_percent,
         yes,
+        diff,
     )
     override_data = _set_override_data(
         data,
@@ -549,6 +557,7 @@ def _set_config(
     shell_executable,
     fail_percent,
     yes,
+    diff,
 ):
     logger.info("--> Loading config...")
 
@@ -583,6 +592,9 @@ def _set_config(
     if fail_percent is not None:
         config.FAIL_PERCENT = fail_percent
 
+    if diff:
+        config.DIFF = True
+
     return config