Python 命令行脚本编写规范（argparse 模板）

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

#!/usr/bin/env python3
"""
Description: 将 FASTA 文件中的序列按长度过滤
Input:       FASTA 格式文件
Output:      过滤后的 FASTA 文件
"""

import argparse
import logging
import sys
from pathlib import Path
from concurrent.futures import ProcessPoolExecutor

VERSION = "1.0.0"
LOGGER_FORMAT = "%(asctime)s - %(levelname)s - %(message)s"


def parse_args() -> argparse.Namespace:
    parser = argparse.ArgumentParser(
        description="按序列长度过滤 FASTA 文件",
        epilog="""示例:
  python filter_fasta.py -i input.fa -o output.fa -m 200
  python filter_fasta.py -i input.fa -o output.fa -m 100 -M 500 -t 8""",
        formatter_class=argparse.RawDescriptionHelpFormatter,
    )
    parser.add_argument("-i", "--input", required=True, help="输入 FASTA 文件")
    parser.add_argument("-o", "--output", required=True, help="输出 FASTA 文件")
    parser.add_argument("-m", "--min-len", type=int, default=0, help="最小长度 (默认: 0)")
    parser.add_argument("-M", "--max-len", type=int, default=0, help="最大长度 (0=不限)")
    parser.add_argument("-t", "--threads", type=int, default=4, help="线程数 (默认: 4)")
    parser.add_argument("--log-level", default="INFO", choices=["DEBUG","INFO","WARNING","ERROR"])
    parser.add_argument("--log-file", help="日志输出文件")
    parser.add_argument("--force", action="store_true", help="覆盖已有输出文件")
    parser.add_argument("--version", action="version", version=f"%(prog)s {VERSION}")
    return parser.parse_args()


def main():
    args = parse_args()

    # 日志配置
    handlers = [logging.StreamHandler()]
    if args.log_file:
        handlers.append(logging.FileHandler(args.log_file))
    logging.basicConfig(level=args.log_level, format=LOGGER_FORMAT, handlers=handlers)

    # 输入校验
    if not Path(args.input).exists():
        logging.error(f"输入文件不存在: {args.input}")
        sys.exit(1)
    if Path(args.output).exists() and not args.force:
        logging.error(f"输出文件已存在: {args.output}，使用 --force 覆盖")
        sys.exit(1)

    logging.info(f"开始处理: {args.input}")
    # ... 核心逻辑 ...
    logging.info(f"完成! 输出: {args.output}")


if __name__ == "__main__":
    main()