Python脚本-rename_dirs_files

2025-01-01

该脚本允许您指定一个目录，它将重命名所有文件（默认行为），并可选择重命名子目录

Source Code

# -*- coding: utf-8 -*-
"""
Script to rename all files and/or subdirectories in a given directory by replacing a specified substring with a new one.
Author: ZLin
Date: 2025-01-01
Description: This script allows you to specify a directory, and it will rename all files (default behavior), and optionally rename subdirectories if '-d' or '--dir' is provided, by replacing a specified substring with a new one.
"""

import os
import argparse

class Renamer:
  def __init__(self, directory, old_string, new_string, rename_directories=False, verbose=False):
    self.directory = directory
    self.old_string = old_string
    self.new_string = new_string
    self.rename_directories_flag = rename_directories
    self.verbose = verbose

  def print_verbose(self, message):
    if self.verbose:
      print(message)

  def rename_files(self):
    try:
      # Walk through the directory and its files
      for root, _, files in os.walk(self.directory):
        for file_name in files:
          if self.old_string in file_name:
            old_file_path = os.path.join(root, file_name)
            new_file_name = file_name.replace(self.old_string, self.new_string)
            new_file_path = os.path.join(root, new_file_name)

            # Rename the file
            os.rename(old_file_path, new_file_path)
            self.print_verbose(f"Renamed file: {old_file_path} -> {new_file_path}")
    except Exception as e:
      print(f"Error while renaming files: {e}")

  def rename_directories(self):
    try:
      # Walk through the directory and its subdirectories
      for root, dirs, _ in os.walk(self.directory):
        for dir_name in dirs:
          if self.old_string in dir_name:
            old_dir_path = os.path.join(root, dir_name)
            new_dir_name = dir_name.replace(self.old_string, self.new_string)
            new_dir_path = os.path.join(root, new_dir_name)

            # Rename the directory
            os.rename(old_dir_path, new_dir_path)
            self.print_verbose(f"Renamed directory: {old_dir_path} -> {new_dir_path}")
    except Exception as e:
      print(f"Error while renaming directories: {e}")

  def rename_all(self):
    # Rename files by default
    self.rename_files()
    # Rename directories if rename_directories is True
    if self.rename_directories_flag:
      self.rename_directories()


def main():
  parser = argparse.ArgumentParser(description="Rename all files and/or subdirectories by replacing a specified substring with a new one.")
  parser.add_argument('-r', '--replace', type=str, required=True, help="The directory to process.")
  parser.add_argument('-o', '--old_string', type=str, required=True, help="The old substring to replace.")
  parser.add_argument('-n', '--new_string', type=str, required=True, help="The new substring to replace with.")
  parser.add_argument('-d', '--dir', action='store_true', help="Enable renaming of directories (by default only files are renamed).")
  parser.add_argument('-v', '--verbose', action='store_true', help="Enable verbose output. If not specified, no output is shown.")
  args = parser.parse_args()

  renamer = Renamer(args.replace, args.old_string, args.new_string, rename_directories=args.dir, verbose=args.verbose)
  renamer.rename_all()


if __name__ == "__main__":
  main()

脚本概述

rename_dirs_files.py 是一个 Python 脚本，用于遍历指定目录（及其子目录），并根据提供的旧字符串和新字符串，将目录和文件名中的旧字符串替换为新字符串。用户可以选择只修改文件名，或者同时修改文件和目录名。此外，还可以通过 verbose 参数启用详细的输出信息。

功能

替换文件名中的旧字符串为新字符串：
- 默认情况下，脚本会遍历指定目录中的所有文件，将文件名中包含旧字符串的部分替换为新字符串。
替换目录名中的旧字符串为新字符串：
- 如果提供了 -d 或 --dir 参数，脚本会遍历指定目录中的所有子目录，并将目录名中包含旧字符串的部分替换为新字符串。
详细输出（Verbose）：
- 如果提供了 -v 或 --verbose 参数，脚本会打印每个文件或目录的重命名操作的详细信息。否则，默认不输出任何信息。

命令行参数

-r / --replace
必需
指定要处理的根目录路径。该目录及其所有子目录下的文件和（或）文件夹将会被重命名。
-o / --old_string
必需
要替换的旧字符串。如果文件名或目录名中包含该字符串，则会被替换为新字符串。
-n / --new_string
必需
用来替换旧字符串的字符串。该字符串将替换文件名或目录名中的旧字符串。
-d / --dir
可选
如果指定此参数，脚本会修改目录名。如果未提供该参数，脚本只会修改文件名。
-v / --verbose
可选
启用详细输出信息。指定此参数后，脚本会在每个重命名操作时打印详细的操作信息（如文件名或目录名的旧路径和新路径）。如果未指定此参数，脚本将不会输出任何信息。

示例

1. 只修改文件名（默认）

假设你要处理目录 /path/to/directory，并将所有文件名中的 ddr3 替换为 ddr4：

1 2	python rename_dirs_files.py -r /path/to/directory -o ddr3 -n ddr4

解释：

xxxxxxxxxx1 1python remove_line.py -d /path/to/directory -s “sim_level ?=” -r “sim_level = 1” -vbash
文件名中包含 ddr3 的部分将被替换为 ddr4。

2. 同时修改文件和目录名

如果你还想同时修改目录名，可以加上 -d 或 --dir 参数：

1	python rename_dirs_files.py -r /path/to/directory -o ddr3 -n ddr4 -d

解释：

文件和目录名中的 ddr3 都将被替换为 ddr4。

3. 启用详细输出

如果你希望在执行过程中看到每个重命名操作的详细信息，可以加上 -v 或 --verbose 参数：

1	python rename_dirs_files.py -r /path/to/directory -o ddr3 -n ddr4 -d -v

输出示例：

Renamed file: /path/to/directory/test.txt -> /path/to/directory/test.txt
Renamed file: /path/to/directory/ddr3_example.txt -> /path/to/directory/ddr4_example.txt
Renamed directory: /path/to/directory/ddr3_test -> /path/to/directory/ddr4_test
Renamed directory: /path/to/directory/random_ddr3_folder -> /path/to/directory/random_ddr4_folder

解释：

4. 不启用详细输出

如果没有提供 -v 参数，脚本将不会打印任何信息。

1 2	python rename_dirs_files.py -r /path/to/directory -o ddr3 -n ddr4

输出：无（没有任何打印信息）。

本文作者： ICXNM-ZLin
本文链接： https://talent-tudou.github.io/2025/01/01/Programming/Python脚本-rename-dirs-files/
版权声明： 本作品采用 CC BY-NC-SA 4.0 进行许可。转载请注明出处！