最大限度地减少 Python 脚本参数的代码重复（使用“argparse”或其他模块）

Question

假设有多个脚本：script_1.py、script_2.py、script_3.py、script_4.py 、script_5.py、script_6.py 等，目标是最大限度地减少脚本作为输入的参数的代码重复。

作为场景示例：

• script_1.py、script_2.py、script_3.py 有几个共同的参数 =>可能的解决方案：可以利用argparse的parent_parser
• script_4.py、script_5.py、script_6.py有几个共同的参数=>可能的解决方案：可以利用argparse的parent_parser
• script_5.py script_6.py script_7.py script_8.py有一个共同点 =>可能的解决方案：将 args 放入字典中（下面的片段示例）

"""
python run_app_w_argparse_example.py --arg_1 1
"""
import argparse
from typing import Dict

APPS_ARGS = {"--arg_1": dict(help="arg_1 description", type=int),
             "--arg_2": dict(help="arg_2 description", type=str, default="hi")}


def parser_example() -> Dict:
    parser = argparse.ArgumentParser(description="Description")
    parser.add_argument("--arg_1", **APPS_ARGS["--arg_1"])
    return vars(parser.parse_args())


if __name__ == '__main__':
    print(parser_example())

一个不方便的地方是“--arg1”在 add_argument 中重复两次。有办法避免这种情况吗？总体上有更好的解决方案吗？

Answer 1

这是我在使用子命令或有许多共享相同基本参数的脚本时偶尔用于 python 工具的模式。

简而言之，我创建了一个嵌套结构（我承认看起来有点可怕），它允许动态创建解析器。

基本布局是：

args = Tuple[Tuple[str, ..., dict], ...]

每个内部元组都包含 CLI 标志和参数选项的字典。
字典必须是最后一个元素。
这样做的原因是因为元组可以相互附加，因此参数可以堆叠起来。

import argparse

DEFAULT_SERVER_HOST = "127.0.0.1"
DEFAULT_SERVER_PORT = 5555
DEFAULT_TIMEOUT = 500

BASE_ARGS = (
    (
        "-H",  # FLAG
        "--host",  # FLAG
        dict(  # OPTIONS
            help="Server host address (default: {})".format(DEFAULT_SERVER_HOST),
            default=DEFAULT_SERVER_HOST,
        ),
    ),
    (
        "-P",
        "--port",
        dict(
            help="Server port (default: {})".format(DEFAULT_SERVER_PORT),
            default=DEFAULT_SERVER_PORT,
        ),
    ),
    (
        "-o",
        dict(type=str, help="Output filename", required=True),
    ),
    (
        "--timeout",
        dict(
            type=int,
            help="Connection timeout in seconds (default: {})".format(DEFAULT_TIMEOUT),
            default=DEFAULT_TIMEOUT,
        ),
    ),
)

def get_args(default_args=None, extra_args=None, prog=""):
    if default_args is None:
        args = BASE_ARGS
    else:
        args = default_args

    if extra_args is not None:
        args = args + extra_args

    parser = argparse.ArgumentParser(prog)

    for *flags, opts in args:
        parser.add_argument(*flags, **opts)

    return parser, parser.parse_args()

def main():
    extra_args = (
        (
            "--log-file",
            dict(help="File to write logs to"),
        ),
    )

    parser, args = get_args(extra_args=extra_args, prog="My script")
    print(args)

if __name__ == "__main__":
    main()