【Python】一文向您详细介绍 argparse中 action=‘store_true’ 的作用
下滑即可查看博客内容
🌈 欢迎莅临我的个人主页 👈这里是我静心耕耘深度学习领域、真诚分享知识与智慧的小天地！🎇
🎓 博主简介：985高校的普通本硕，曾有幸发表过人工智能领域的 中科院顶刊一作论文，熟练掌握PyTorch框架。
🔧 技术专长： 在CV、NLP及多模态等领域有丰富的项目实战经验。已累计提供近千次定制化产品服务，助力用户少走弯路、提高效率，近一年好评率100% 。
📝 博客风采： 积极分享关于深度学习、PyTorch、Python相关的实用内容。已发表原创文章600余篇，代码分享次数逾九万次。
💡 服务项目：包括但不限于科研辅导、知识付费咨询以及为用户需求提供定制化解决方案。
🌵文章目录🌵
- 📚 一、认识`argparse`与`action='store_true'`
- 示例场景
- 🚀 二、`action='store_true'`的基本用法
- 💡 三、完整命令行指令示例
- 🔍 四、举一反三：`action='store_false'`
- 示例
- 📚 五、`argparse`的更多应用场景
- 位置参数
- 互斥参数组
- 🚀 六、总结与展望
下滑即可查看博客内容
📚 一、认识argparse与action='store_true'
在Python中，argparse模块是处理命令行参数的标准库之一，它让编写用户友好的命令行接口变得简单。通过argparse，程序可以轻松地读取命令行参数，并根据这些参数执行不同的操作。而action='store_true'是argparse中一个非常实用的参数，它允许我们定义一个标志（flag），当这个标志在命令行中被指定时，自动将对应的变量设置为True。
示例场景
假设我们正在编写一个脚本，该脚本默认执行某个操作，但用户可以通过命令行参数来启用额外的功能。这时，action='store_true'就显得非常有用。
🚀 二、action='store_true'的基本用法
下面是一个简单的例子，演示了如何在argparse中使用action='store_true'。
import argparse
# 创建 ArgumentParser 对象
parser = argparse.ArgumentParser(description='示例脚本，展示 action=store_true 的用法。')
# 添加一个标志 --verbose，当它被指定时，verbose 变量将被设置为 True
parser.add_argument('--verbose', help='启用详细模式', action='store_true')
# 解析命令行参数
args = parser.parse_args()
# 根据 verbose 的值执行不同的操作
if args.verbose:
print('详细模式已启用！')
else:
print('执行默认操作。')
在这个例子中，如果用户运行脚本时没有指定--verbose标志，那么args.verbose将会是False（因为action='store_true'的默认值是False），脚本将执行默认操作。如果用户指定了--verbose（如python script.py --verbose），则args.verbose会被设置为True，脚本将输出“详细模式已启用！”。
💡 三、完整命令行指令示例
假设上述脚本保存为script.py，那么完整的命令行指令如下：
-
执行默认操作（不启用详细模式）：
python script.py输出将会是：“执行默认操作。”
-
启用详细模式：
python script.py --verbose输出将会是：“详细模式已启用！”
🔍 四、举一反三：action='store_false'
action='store_false'是argparse模块中另一个实用的参数动作，它与action='store_true'相对应，但行为相反。当在命令行中指定了与action='store_false'相关联的标志时，相应的变量会被设置为False。这在需要明确禁用某些默认开启的功能时特别有用。
示例
假设我们有一个脚本，它默认会打印一些调试信息，但我们想要通过命令行参数来禁用这些调试信息。
import argparse
parser = argparse.ArgumentParser(description='示例脚本，展示 action=store_false 的用法。')
# 添加一个标志 --no-debug，当它被指定时，debug 变量将被设置为 False
parser.add_argument('--no-debug', help='禁用调试信息', action='store_false')
# 注意：我们没有为 debug 变量设置默认值，但根据 argparse 的规则，action=store_false 的默认值实际上是 True
# 如果想要明确设置默认值，可以使用 default=True 参数
# parser.add_argument('--no-debug', help='禁用调试信息', action='store_false', default=True)
# 解析命令行参数
args = parser.parse_args()
# 如果 args.no_debug 为 False（即 --no-debug 没有被指定），则打印调试信息
if not args.no_debug:
print('调试信息：这是调试信息的示例。')
else:
print('调试信息已禁用。')
在这个例子中，如果用户没有指定--no-debug标志，则args.no_debug的值为True（因为action='store_false'的“未指定”状态被视为True，但这通常不是我们想要的行为，所以更推荐使用default=True来明确设置默认值），脚本将打印调试信息。如果用户指定了--no-debug，则args.no_debug会被设置为False，脚本将输出“调试信息已禁用。”。然而，为了清晰和避免混淆，推荐总是为使用action='store_false'的参数明确设置default=True。
📚 五、argparse的更多应用场景
argparse模块不仅仅局限于简单的标志（flag）处理，它还可以处理位置参数（positional arguments）、互斥参数组（mutually exclusive groups）、子命令（subcommands）等复杂场景。
位置参数
位置参数是命令行中按照特定顺序出现的参数，它们不需要前缀（如--）。
parser.add_argument('filename', help='要处理的文件名')
互斥参数组
互斥参数组允许你定义一组参数，这些参数中一次只能指定一个。
group = parser.add_mutually_exclusive_group()
group.add_argument('--verbose', action='store_true')
group.add_argument('--quiet', action='store_true')
🚀 六、总结与展望
通过本文，我们深入了解了argparse模块中action='store_true'和action='store_false'的作用，以及如何在命令行中具体使用它们。我们还通过示例展示了argparse的基本用法和进阶用法，包括位置参数、互斥参数组等。这些功能使得argparse成为Python中处理命令行参数的首选库。
展望未来，随着Python在数据科学、机器学习、Web开发等领域的广泛应用，命令行工具的重要性日益凸显。掌握argparse模块，将帮助我们编写出更加用户友好、功能强大的命令行工具。同时，随着Python生态的不断发展，我们也可以期待argparse模块本身能够继续进化，为我们提供更多便利和强大的功能。
最后，希望本文能够帮助读者更好地理解和使用argparse模块，从而编写出更加优秀的Python脚本和命令行工具。🎉
