Add utility methods for replacing text areas and lines

_shared/src/shared_utils/__init__.py

@@ -64,6 +64,59 @@ def replace_in_file(file_path: str, text: str, replacement: str) -> None:
             file.write(line)
 
 
+def replace_line(
+    text: List[str], matching_text: str, replacement: str = ""
+) -> List[str]:
+    """Replace the whole line which matches the given text with a replacement.
+
+    Args:
+        text (List[str]): All text lines to replace lines within.
+        text (str): The text to find the line with.
+        replacement (str): The replacement for line.
+    """
+    buffer = []
+    for line in text:
+        if line.__contains__(matching_text):
+            line = replacement
+
+            isEmptyLine = line == ""
+            if isEmptyLine:
+                continue
+
+        buffer.append(line)
+
+    return buffer
+
+
+def replace_text_area(
+    text: List[str], start_occurence: str, end_occurence: str, replacement: str = ""
+) -> List[str]:
+    """Replace all occurrences of all text areas matching the parameters with a replacement.
+
+    Args:
+        text (List[str]): All text lines to replace text within.
+        start_occurence (str): The starting line which matches the occurence for replacement text area.
+        start_occurence (str): The ending line which matches the occurence for replacement text area.
+        replacement (str): The replacement for text area.
+    """
+    buffer = []
+    is_capturing = False
+    for line in text:
+        if not is_capturing and line.__contains__(start_occurence):
+            is_capturing = True
+            continue
+
+        if is_capturing:
+            if line.__contains__(end_occurence):
+                replacement = line.replace(line, replacement)
+                buffer.append(replacement)
+                is_capturing = False
+        else:
+            buffer.append(line)
+
+    return buffer
+
+
 def get_valid_arch(arch: str) -> str:
     """Return a known architecture for the given `arch`.