file_parser.py

Go to the documentation of this file.

# Copyright (C) 2002-2021 CERN for the benefit of the ATLAS collaboration
 
# @PowhegControl FileParser
#  PowhegControl Text alteration operations for files
#
#  Authors: James Robinson  <james.robinson@cern.ch>
 
#! /usr/bin/env python
import glob
import os
import re
import shutil
 
 
class FileParser(object):
    """! Utility class to perform simple operations on files."""
 
    def __init__(self, input_file_pattern):
        """! Initialise with an file pattern.
 
        @param input_file_pattern Pattern of files to perform actions on.
        """
        self.__input_file_names = glob.glob(input_file_pattern)
 
    def text_append(self, string_append):
        """! Append string_append in input_file_name.
 
        @param string_append String to append.
        """
        for input_file_name in self.__input_file_names:
            with open(input_file_name, "ab") as f_input:
                f_input.write(string_append + "\n")
 
    def text_replace(self, regex_find, string_replace, count=0, regex_line_match=None):
        """! Replace regex_find by regex_replace in input_file_name.
        Returns the number of lines where such replacement was made.
 
        @param regex_find        Regular expression to search for.
        @param string_replace    String to replace by.
        @param count             If non-zero then only replace first count occurences in each line.
        @param regex_line_match  If not 'None' then only do replacement on lines matching this
        """
        replaced_lines = 0
        c_regex_find = re.compile(regex_find)
        for input_file_name in self.__input_file_names:
            shutil.move(input_file_name, "{}.text_replace_backup".format(input_file_name))
            with open("{}.text_replace_backup".format(input_file_name), "r") as f_input:
                with open(input_file_name, "w") as f_output:
                    for line in f_input:
                        if regex_line_match is not None and not re.search(regex_line_match, line):
                            f_output.write(line)
                            continue
                        new_line = c_regex_find.sub(string_replace, line.rstrip(), count)
                        f_output.write(new_line + "\n")
                        replaced_lines += 1
            os.remove("{}.text_replace_backup".format(input_file_name))
        return replaced_lines
 
    def text_replace_multi(self, regex_find_replace_count, regex_line_match=None):
        """! Replace a whole list of regex_find_replace_count in input_file_name.
        Returns the number of lines where such replacement was made.
 
        @param regex_find_replace_count    List of regular expressions to search for, strings to replace by, and how often to replace
        @param regex_line_match  If not 'None' then only do replacement on lines matching this
        """
        replaced_lines = 0
        for i in range(len(regex_find_replace_count)):
            regex_find_replace_count[i][0] = re.compile(regex_find_replace_count[i][0])
        for input_file_name in self.__input_file_names:
            shutil.move(input_file_name, "{}.text_replace_backup".format(input_file_name))
            f_input = open("{}.text_replace_backup".format(input_file_name), "r")
            f_output = open(input_file_name, "w")
            for line in f_input:
                if regex_line_match is not None and not re.search(regex_line_match, line):
                    f_output.write(line)
                    continue
                new_line = line.rstrip()
                for i in range(len(regex_find_replace_count)):
                    if regex_find_replace_count[i][2] != 0 and regex_find_replace_count[i][0].match(new_line):
                        new_line = regex_find_replace_count[i][0].sub(regex_find_replace_count[i][1], new_line)
                        regex_find_replace_count[i][2] -= 1
                        replaced_lines += 1
                f_output.write(new_line + "\n")
            os.remove("{}.text_replace_backup".format(input_file_name))
        return replaced_lines
 
    def text_remove(self, regex_find):
        """! Remove lines matching regex_find in input_file_name.
        Returns the number of removed lines.
 
        @param regex_find Regular expression to search for.
        """
        removed_lines = 0
        c_regex_find = re.compile(regex_find)
 
        for input_file_name in self.__input_file_names:
            shutil.move(input_file_name, "{}.text_replace_backup".format(input_file_name))
            with open("{}.text_replace_backup".format(input_file_name), "r") as f_input:
                with open(input_file_name, "w") as f_output:
                    for line in f_input:
                        if c_regex_find.search(line.rstrip()) is None:
                            f_output.write(line)
                        else:
                            removed_lines += 1
            os.remove("{}.text_replace_backup".format(input_file_name))
        return removed_lines
 
    def text_remove_all_if_one_line_matches(self, regex_find, pattern_to_match):
        """! Remove all lines matching regex_find in input_file_name
        if at least one also maches pattern_to_match.
        Returns the number of removed lines.
 
        @param regex_find Regular expression to search for in the lines to be considered.
        @param pattern_to_match Regular expression to search for in those lines.
        """
        remove = False
        # first check if at least one such lines matches pattern_to_match
        for input_file_name in self.__input_file_names:
            with open(input_file_name, "r") as f_input:
                for line in f_input:
                    if re.search(regex_find, line.rstrip()) is not None and re.search(pattern_to_match, line.rstrip()) is not None:
                        remove = True
                        break # no need to continue, one instance is sufficient
 
        removed_lines = 0
        # then if that's the case, remove all such lines
        if remove:
            for input_file_name in self.__input_file_names:
                shutil.move(input_file_name, "{}.text_replace_backup".format(input_file_name))
                with open("{}.text_replace_backup".format(input_file_name), "r") as f_input:
                    with open(input_file_name, "w") as f_output:
                        for line in f_input:
                            if re.search(regex_find, line.rstrip()) is None:
                                f_output.write(line)
                            else:
                                removed_lines += 1
                os.remove("{}.text_replace_backup".format(input_file_name))
        return removed_lines