files.line, crontab.crontab: actually delete lines when present=False

* operations/utils/files.py:
Add sed_delete().
Factor out common code from sed_replace and sed_delete into _sed_command().
Add _set_delete_builder() and _sed_replace_builder() to build the actual sed
expression.

* operations/files.py line(): use sed_delete().
* operations/crontab.py crontab(): use sed_delete().

* tests/operations/apt.repo/remove.json,
tests/operations/bsdinit.service/disabled.json,
tests/operations/crontab.crontab.remove.json: adjust expected commands.

Author: bad

pyinfra/operations/crontab.py

@@ -6,7 +6,7 @@
 from pyinfra.api import StringCommand, operation
 from pyinfra.api.util import try_int
 from pyinfra.facts.crontab import Crontab, CrontabFile
-from pyinfra.operations.util.files import sed_replace
+from pyinfra.operations.util.files import sed_delete, sed_replace
 
 
 @operation()
@@ -111,7 +111,7 @@ def comma_sep(value):
     # Don't want the cron and it does exist? Remove the line
     if not present and exists:
         edit_commands.append(
-            sed_replace(
+            sed_delete(
                 temp_filename,
                 existing_crontab_match,
                 "",

pyinfra/operations/files.py

@@ -56,7 +56,14 @@
 from pyinfra.facts.server import Date, Which
 
 from .util import files as file_utils
-from .util.files import adjust_regex, ensure_mode_int, get_timestamp, sed_replace, unix_path_join
+from .util.files import (
+    adjust_regex,
+    ensure_mode_int,
+    get_timestamp,
+    sed_delete,
+    sed_replace,
+    unix_path_join,
+)
 
 
 @operation()
@@ -427,9 +434,9 @@ def line(
         else:
             host.noop('line "{0}" exists in {1}'.format(replace or line, path))
 
-    # Line(s) exists and we want to remove them, replace with nothing
+    # Line(s) exists and we want to remove them
     elif present_lines and not present:
-        yield sed_replace(
+        yield sed_delete(
             path,
             match_line,
             "",

pyinfra/operations/util/files.py

@@ -2,6 +2,7 @@
 
 import re
 from datetime import datetime
+from typing import Callable
 
 from pyinfra.api import QuoteString, StringCommand
 
@@ -32,13 +33,55 @@ def get_timestamp() -> str:
     return datetime.now().strftime("%y%m%d%H%M")
 
 
+_sed_ignore_case = re.compile("[iI]")
+
+
+def _sed_delete_builder(line: str, replace: str, flags: str, interpolate_variables: bool) -> str:
+    return (
+        '"/{0}/{1}d"' if interpolate_variables else  # fmt: skip
+        "'/{0}/{1}d'"
+    ).format(line, "I" if _sed_ignore_case.search(flags) else "")
+
+
+def sed_delete(
+    filename: str,
+    line: str,
+    replace: str,
+    flags: list[str] | None = None,
+    backup=False,
+    interpolate_variables=False,
+) -> StringCommand:
+    return _sed_command(**locals(), sed_script_builder=_sed_delete_builder)
+
+
+def _sed_replace_builder(line: str, replace: str, flags: str, interpolate_variables: bool) -> str:
+    return (
+        '"s/{0}/{1}/{2}"' if interpolate_variables else  # fmt: skip
+        "'s/{0}/{1}/{2}'"
+    ).format(line, replace, flags)
+
+
 def sed_replace(
     filename: str,
     line: str,
     replace: str,
     flags: list[str] | None = None,
     backup=False,
     interpolate_variables=False,
+) -> StringCommand:
+    return _sed_command(**locals(), sed_script_builder=_sed_replace_builder)
+
+
+def _sed_command(
+    filename: str,
+    line: str,
+    replace: str,
+    flags: list[str] | None = None,
+    backup=False,
+    interpolate_variables=False,
+    # Python requires a default value here, so use _sed_replace_builder for
+    # backwards compatibility.
+    sed_script_builder: Callable[[str, str, str, bool], str] = _sed_replace_builder,
 ) -> StringCommand:
     flags_str = "".join(flags) if flags else ""
 
@@ -51,15 +94,13 @@ def sed_replace(
     if interpolate_variables:
         line = line.replace('"', '\\"')
         replace = replace.replace('"', '\\"')
-        sed_script_formatter = '"s/{0}/{1}/{2}"'
     else:
         # Single quotes cannot contain other single quotes, even when escaped , so turn
         # each ' into '"'"' (end string, double quote the single quote, (re)start string)
         line = line.replace("'", "'\"'\"'")
         replace = replace.replace("'", "'\"'\"'")
-        sed_script_formatter = "'s/{0}/{1}/{2}'"
 
-    sed_script = sed_script_formatter.format(line, replace, flags_str)
+    sed_script = sed_script_builder(line, replace, flags_str, interpolate_variables)
 
     sed_command = StringCommand(
         "sed",

tests/operations/apt.repo/remove.json

@@ -16,6 +16,6 @@
         }
     },
     "commands": [
-        "sed -i.a-timestamp 's/^.*deb http:\\/\\/archive\\.canonical\\.com\\/ubuntu hardy partner.*$//' /etc/apt/sources.list && rm -f /etc/apt/sources.list.a-timestamp"
+        "sed -i.a-timestamp '/^.*deb http:\\/\\/archive\\.canonical\\.com\\/ubuntu hardy partner.*$/d' /etc/apt/sources.list && rm -f /etc/apt/sources.list.a-timestamp"
     ]
 }

tests/operations/bsdinit.service/disabled.json

@@ -15,6 +15,6 @@
         }
     },
     "commands": [
-        "sed -i.a-timestamp 's/^nginx_enable=.*$//' /etc/rc.conf.local && rm -f /etc/rc.conf.local.a-timestamp"
+        "sed -i.a-timestamp '/^nginx_enable=.*$/d' /etc/rc.conf.local && rm -f /etc/rc.conf.local.a-timestamp"
     ]
 }

tests/operations/crontab.crontab/remove.json

@@ -19,7 +19,7 @@
     },
     "commands": [
         "crontab -l  > _tempfile_",
-        "sed -i.a-timestamp 's/.*this_is_a_command.*//' _tempfile_ && rm -f _tempfile_.a-timestamp",
+        "sed -i.a-timestamp '/.*this_is_a_command.*/d' _tempfile_ && rm -f _tempfile_.a-timestamp",
         "crontab  _tempfile_"
     ]
 }