File indexing completed on 2024-06-23 04:15:19

 #!/usr/bin/env python3
 
 # Generic search & replace tool
 # https://github.com/aureliojargas/replace
 #
 # SPDX-FileCopyrightText: 2016 Aurelio Jargas <aurelio at aurelio dot net>
 #
 # SPDX-License-Identifier: BSD-3-Clause
 #
 
 """
 Replaces text using string or regex matching.
 
 Examples:
   # Replace all mentions of old.css with new.css in all HTML files
   replace --from old.css --to new.css --in-place *.html
 
   # Update the AdSense code in all HTML files
   # The old and the new code are in separate files
   replace --from-file adsense.old --to-file adsense.new -i *.html
 
   # Enclose all numbers inside square brackets: 123 -> [123]
   replace --regex --from '(\\d+)' --to '[\\1]' file.txt
 """
 
 import argparse
 import re
 import sys
 
 
 def read_file(path):
     if path == "-":
         return sys.stdin.read()
     # The newline argument preserves the original line break (see issue #2)
     with open(path, "r", newline="", encoding="utf-8") as myfile:
         return myfile.read()
 
 
 def save_file(path, content):
     with open(path, "w", encoding="utf-8") as myfile:
         myfile.write(content)
 
 
 def setup_cmdline_parser():
     parser = argparse.ArgumentParser(
         description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter
     )
 
     # from
     group = parser.add_mutually_exclusive_group()
     group.add_argument(
         "-f",
         "--from",
         metavar="TEXT",
         dest="from_",
         help="specify the search text or regex",
     )
     group.add_argument(
         "-F", "--from-file", metavar="FILE", help="read the search text from this file"
     )
 
     # to
     group = parser.add_mutually_exclusive_group()
     group.add_argument(
         "-t", "--to", metavar="TEXT", help="specify the replacement text"
     )
     group.add_argument(
         "-T",
         "--to-file",
         metavar="FILE",
         help="read the replacement text from this file",
     )
 
     # other
     parser.add_argument(
         "-r",
         "--regex",
         action="store_true",
         help="use regex matching instead of string matching",
     )
     parser.add_argument(
         "-i", "--in-place", action="store_true", help="edit files in-place"
     )
     parser.add_argument(
         "-v", "--verbose", action="store_true", help="turn on verbose mode"
     )
 
     # files
     parser.add_argument("files", metavar="FILE", nargs="+", help="input files")
     return parser
 
 
 def validate_config(config):
     # Set search pattern
     if config.from_file:
         config.from_value = read_file(config.from_file)
     elif config.from_:
         config.from_value = config.from_
     else:
         sys.exit("Error: No search pattern (use --from or --from-file)")
 
     # Set replacement
     if config.to_file:
         config.to_value = read_file(config.to_file)
     elif config.to is not None:  # could also be ''
         config.to_value = config.to
     else:
         sys.exit("Error: No replace pattern (use --to or --to-file)")
 
 
 def main(args=None):
     parser = setup_cmdline_parser()
     config = parser.parse_args(args)
     validate_config(config)
 
     from_ = config.from_value
     to_ = config.to_value
 
     for input_file in config.files:
 
         if config.verbose:
             print("----", input_file)
 
         original = read_file(input_file)
 
         # do the replace
         if config.regex:
             modified = re.sub(from_, to_, original)
         else:
             modified = original.replace(from_, to_)
 
         # save or show results
         if config.in_place:
             if modified == original:
                 continue  # do not save unchanged files
             save_file(input_file, modified)
             print("Saved", input_file)
         else:
             print(modified, end="")
 
 
 if __name__ == "__main__":
     main()