如何用argparse实现两个可选参数需同时提供或都不提供？

要实现arg1必填，且opt-arg-1和opt-arg-2必须同时提供或都不提供的校验逻辑，用Python标准库的argparse就能轻松搞定，核心思路是参数解析完成后手动校验成对参数的存在状态。

完整实现代码 #

import argparse

def main():
    parser = argparse.ArgumentParser(description="带参数成对校验的Python脚本")
    # 定义必填参数arg1
    parser.add_argument('--arg1', required=True, help='必填参数，必须提供有效值')
    # 定义两个需成对出现的可选参数
    parser.add_argument('--opt-arg-1', help='可选参数，需与opt-arg-2同时使用')
    parser.add_argument('--opt-arg-2', help='可选参数，需与opt-arg-1同时使用')
    
    args = parser.parse_args()
    
    # 校验成对参数的存在状态
    has_opt1 = args.opt_arg_1 is not None
    has_opt2 = args.opt_arg_2 is not None
    if has_opt1 != has_opt2:
        parser.error("opt-arg-1和opt-arg-2必须同时提供或都不提供")
    
    # 后续业务逻辑示例
    print("参数校验通过，开始执行脚本")
    print(f"arg1的值：{args.arg1}")
    if has_opt1:
        print(f"opt-arg-1的值：{args.opt_arg_1}，opt-arg-2的值：{args.opt_arg_2}")

if __name__ == "__main__":
    main()

代码关键说明 #

• --arg1通过required=True标记为必填参数，解析时若未传入会直接触发argparse内置的必填参数错误提示。
• 解析完成后，通过判断两个可选参数是否为None，来校验它们的成对状态：如果一个存在、另一个不存在，调用parser.error()输出自定义错误信息，格式与argparse内置错误风格保持一致。

测试场景验证 #

• 执行python my_script.py --arg1 val1：校验通过，正常执行后续逻辑。
• 执行python my_script.py --arg1 val1 --opt-arg-1 other_val：触发错误，输出error: opt-arg-1和opt-arg-2必须同时提供或都不提供。
• 执行python my_script.py --arg1 val1 --opt-arg-2 other_val：同样触发上述错误。
• 执行python my_script.py --arg1 val1 --opt-arg-1 other_val --opt-arg-2 other_val_2：校验通过，正常执行。

内容的提问来源于stack exchange，提问作者arnino