Python脚本-insert_start_end

2025-01-08

脚本的功能是处理一个输入文件，并按指定的间隔插入 start 和 end 标签。

Source Code

#!/bin/python3.6
# -*- coding: utf-8 -*-
"""
Author: ZLin
Date: 2025-01-08
Script Description:
  This script inserts 'start' and 'end' tags at specified intervals after a set of lines in the input file.
  The specified interval is counted after each pair of 'force' and '$disable_warning' lines.
  The processed content is saved to an output file.

Usage:
  python insert_start_end.py -i <input_file_path> -o <output_file_path> -n <interval>
"""

import argparse

class InsertStartEnd:
  def __init__(self, input_file, output_file, interval):
    self.input_file = input_file
    self.output_file = output_file
    self.interval = interval

  def process_file(self):
    with open(self.input_file, 'r') as infile:
      lines = infile.readlines()

    result = ['start']  # Always start with 'start'
    count = 0
    length = len(lines)

    for index, line in enumerate(lines):
      line = line.strip()
      result.append(line)

      # Insert 'start' and 'end' after reaching the specified interval
      count += 1
      if count == self.interval:
        result.append('end')
        if index != length - 1:
          result.append('start')
        count = 0

    # Handle the case where the remaining lines are less than the interval
    if count > 0:
      result.append('end')

    with open(self.output_file, 'w') as outfile:
      outfile.write("\n".join(result))


def main():
  parser = argparse.ArgumentParser(description="Insert 'start' and 'end' at specified intervals.")
  parser.add_argument("-i", "--input", type=str, required=True, help="Input file path")
  parser.add_argument("-o", "--output", type=str, required=True, help="Output file path")
  parser.add_argument("-n", "--interval", type=int, required=True, help="Interval after which to insert 'start' and 'end'")

  args = parser.parse_args()

  inserter = InsertStartEnd(args.input, args.output, args.interval)
  inserter.process_file()
  print(f"Processing complete. Output saved to {args.output}")

if __name__ == "__main__":
  main()

脚本功能

这个 Python 脚本的功能是处理一个输入文件，并按指定的间隔插入 start 和 end 标签。脚本会读取输入文件中的每一行，当读取到指定的间隔行时，会插入 start 和 end，这样你就可以将文件中的内容分成若干个区块。每个区块的内容会在 start 和 end 标签之间。

输入文件格式

假设你的输入文件内容是类似下面的格式：

force xxxxxxxx
$disable_warning(xxx)
force xxxxxxxx
$disable_warning(xxx)
force xxxxxxxx
$disable_warning(xxx)
force xxxxxxxx
$disable_warning(xxx)

插入规则

每当遇到指定的行数（例如每 4 行），在这 4 行之前插入 start 标签，在这 4 行之后插入 end 标签。
文件开头一定会有一个 start 标签。
如果最后一组行数少于指定的间隔，仍然会在其前后加上 start 和 end 标签。

使用步骤

1. 准备 Python 环境

确保你的环境中已经安装了 Python（建议 Python 3.x）。可以通过以下命令检查是否已安装 Python：

1	python --version

2. 运行脚本

使用命令行执行脚本，并指定必要的参数。命令格式如下：

1	python insert_start_end.py -i <input_file_path> -o <output_file_path> -n <interval>

其中：

-i <input_file_path>: 指定输入文件的路径，该文件包含你要处理的内容。
-o <output_file_path>: 指定输出文件的路径，该文件将保存处理后的结果。
-n <interval>: 指定每隔多少行插入一次 start 和 end 标签。比如 -n 4 表示每 4 行插入一次。

示例

假设有一个输入文件 input.txt，内容如下：

force xxxxxxxx
$disable_warning(xxx)
force xxxxxxxx
$disable_warning(xxx)
force xxxxxxxx
$disable_warning(xxx)
force xxxxxxxx
$disable_warning(xxx)

你想要每 4 行插入一次 start 和 end，并将结果保存到 output.txt 中，可以运行以下命令(前面的python可以不写了，我指定了）：

1	python insert_start_end.py -i input.txt -o output.txt -n 4

4. 结果输出

运行后，output.txt 中的内容会如下所示：

start
force xxxxxxxx
$disable_warning(xxx)
force xxxxxxxx
$disable_warning(xxx)
end
start
force xxxxxxxx
$disable_warning(xxx)
force xxxxxxxx
$disable_warning(xxx)
end

文件开头有一个 start 标签。
每四行之后都会插入 end 和 start 标签。
文件的末尾仍然会加上一个 end 标签，确保处理完所有的内容。

参数说明

-i, --input: 输入文件路径。你需要提供你想处理的文件的路径。
-o, --output: 输出文件路径。处理后的内容将保存到这个文件。
-n, --interval: 指定插入 start 和 end 的间隔，单位为行数。例如，-n 4 表示每 4 行插入一次。

错误处理

如果输入文件路径不存在或无法读取，程序会抛出错误并退出。
如果指定的 interval 不是一个有效的整数，程序会提示你输入一个正确的数字。
如果没有提供必需的参数，程序会显示如何正确使用脚本。

注意事项

这个脚本假定输入文件是纯文本文件，并且按行读取。如果文件内容有特殊格式或其他编码，可能需要做额外的处理。
输入文件中的每行都会被按原样复制到输出文件中，除非该行是插入 start 或 end 标签。

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