Python入门必学: argparse基本用法

🌵文章目录🌵

• 一、为什么要使用argparse？💡
• 二、argparse基本用法 📚
• • 1️⃣ 导入argparse模块
  • 2️⃣ 创建ArgumentParser对象
  • 3️⃣ 添加命令行参数
  • 4️⃣ 解析命令行参数
  • 🎉 完整示例
  • 🎁 小结
• 三、进阶用法 🚀
• • 🔄 位置参数和可选参数
  • 🔒 互斥参数
  • 🌈 参数默认值
  • 📋 参数类型
  • 🔍 参数选择
  • 🔒 参数验证
• 四、总结 📚
• 五、最后 🤝

👋大家好！今天我们来聊一聊Python中一个非常实用的模块——argparse。这个模块可以帮助我们轻松地编写用户友好的命令行接口。如果想要为你的Python脚本添加一些命令行参数，argparse会是你的好帮手。🚀

一、为什么要使用argparse？💡

在Python脚本中，我们经常需要处理一些用户输入的参数。这些参数可能是文件路径、操作选项、配置设置等。如果直接使用sys.argv来处理这些参数，代码可能会变得非常混乱，而且不易于维护。argparse模块提供了一个更加直观和灵活的方式来处理命令行参数。

---

二、argparse基本用法 📚

1️⃣ 导入argparse模块

首先，我们需要导入argparse模块：

import argparse

2️⃣ 创建ArgumentParser对象

接下来，我们创建一个ArgumentParser对象，这个对象会保存我们定义的所有命令行参数信息：

parser = argparse.ArgumentParser(description='这是一个示例程序')

这里的description参数是可选的，它用于描述这个命令行程序的主要功能。

3️⃣ 添加命令行参数

然后，我们可以使用add_argument()方法来添加命令行参数。这个方法有很多参数，其中最重要的是name，它指定了命令行参数的名称。例如，我们添加一个名为input的命令行参数：

parser.add_argument('input', type=str, help='输入文件的路径')

这里的type参数指定了参数的类型，help参数用于描述这个参数的作用。如果参数是一个可选参数，我们可以使用--或-前缀来定义它：

parser.add_argument('--output', type=str, help='输出文件的路径')
parser.add_argument('-v', '--verbose', action='store_true', help='显示详细输出')

在上面的例子中，--output是一个可选参数，它的类型是字符串。-v和--verbose是同一个可选参数的两种形式，它们的类型是布尔值，当用户在命令行中指定这个参数时，它的值为True，否则为False。action='store_true'表示当指定这个参数时，将其值设置为True。

4️⃣ 解析命令行参数

最后，我们使用parse_args()方法来解析命令行参数。这个方法会返回一个命名空间，其中包含了所有命令行参数的值：

args = parser.parse_args()

然后，我们就可以通过args.参数名的方式来访问这些参数的值了：

print('输入文件：', args.input)
print('输出文件：', args.output)
print('详细输出：', args.verbose)

注意：在实际的脚本中，我们通常不会直接打印这些参数的值，而是会根据这些值来执行相应的操作。

🎉 完整示例

下面是一个使用argparse模块的完整示例程序：

import argparse

def main():
    # 创建ArgumentParser对象
    parser = argparse.ArgumentParser(description='这是一个文件处理程序')
    
    # 添加命令行参数
    parser.add_argument('input', type=str, help='输入文件的路径')
    parser.add_argument('--output', type=str, default='output.txt', help='输出文件的路径（默认为output.txt）')
    parser.add_argument('-v', '--verbose', action='store_true', help='显示详细输出')
    
    # 解析命令行参数
    args = parser.parse_args()
    
    # 处理输入文件（这里只是简单地打印出参数值）
    print('输入文件：', args.input)
    print('输出文件：', args.output)
    
    # 如果指定了--verbose参数，显示详细输出
    if args.verbose:
        print('详细输出已开启！')
    else:
        print('详细输出已关闭。')

if __name__ == '__main__':
    main()

将上面的代码保存为一个Python脚本（例如file_processor.py），然后在命令行中运行它：

1. 在命令行显式指定verbose参数：

python file_processor.py input.txt --output output.txt -v

输出：

输入文件： input.txt
输出文件： output.txt
详细输出已开启！

2. 在命令行不显式指定verbose参数：

python file_processor.py input.txt --output output.txt

输出：

输入文件： input.txt
输出文件： output.txt
详细输出已关闭。

🎁 小结

通过上面的介绍和示例，我们可以看到argparse模块是一个非常强大和灵活的工具，它可以帮助我们轻松地处理命令行参数。在实际开发中，我们可以根据需要添加更多的命令行参数，并根据这些参数的值来执行相应的操作。通过使用argparse模块，我们可以编写出更加用户友好的命令行工具，提高用户体验和程序的可维护性。

---

三、进阶用法 🚀

除了基本的用法之外，argparse还提供了许多进阶的功能，让你可以更加灵活地控制命令行参数的处理。

🔄 位置参数和可选参数

argparse允许你定义位置参数和可选参数。位置参数是指那些必须按照特定顺序提供的参数，而可选参数则可以使用特定的标志来指定。

parser.add_argument('positional', help='a positional argument')
parser.add_argument('--optional', help='an optional argument')

🔒 互斥参数

你可以使用mutually_exclusive_group来创建一组互斥的参数，这些参数中只能选择一个。

group = parser.add_mutually_exclusive_group(required=True)
group.add_argument('--argument1', action='store_true')
group.add_argument('--argument2', action='store_false')

🌈 参数默认值

你可以为参数设置默认值，这样如果用户没有提供该参数，就会使用默认值。

parser.add_argument('--some-int', type=int, default=42)

📋 参数类型

argparse支持多种参数类型，包括字符串、整数、浮点数、布尔值等。你还可以通过自定义类型来处理更复杂的参数。

parser.add_argument('--count', type=int, help='a simple integer')
parser.add_argument('--file', type=argparse.FileType('r'), help='a readable file')

🔍 参数选择

你可以使用choices参数来限制用户只能选择特定的值。

parser.add_argument('--color', choices=['red', 'blue', 'green'])

🔒 参数验证

argparse支持参数验证，确保用户提供的参数符合特定的条件。

def positive_int(value):
    ivalue = int(value)
    if ivalue < 0:
        raise argparse.ArgumentTypeError('%s is not a positive integer' % value)
    return ivalue

parser.add_argument('--positive-int', type=positive_int, help='a positive integer')

四、总结 📚

argparse是一个强大而灵活的模块，它可以帮助你轻松地处理命令行参数，提高你的Python脚本或程序的用户体验。通过掌握基本用法和进阶功能，你可以编写出更加用户友好的命令行工具，满足各种实际需求。记住，良好的命令行接口是程序与用户之间的重要桥梁，它能够让用户更加方便地使用你的程序，并增加他们对你的程序的信任感。所以，不妨花些时间学习和掌握argparse模块，让你的程序更加出色！

---

五、最后 🤝

🤝 期待与你共同进步

🌱 亲爱的读者，非常感谢你每一次的停留和阅读！你的支持是我们前行的最大动力！🙏

🌐 在这茫茫网海中，有你的关注，我们深感荣幸。你的每一次点赞👍、收藏🌟、评论💬和关注💖，都像是明灯一样照亮我们前行的道路，给予我们无比的鼓舞和力量。🌟

📚 我们会继续努力，为你呈现更多精彩和有深度的内容。同时，我们非常欢迎你在评论区留下你的宝贵意见和建议，让我们共同进步，共同成长！💬

💪 无论你在编程的道路上遇到什么困难，都希望你能坚持下去，因为每一次的挫折都是通往成功的必经之路。我们期待与你一起书写编程的精彩篇章！ 🎉

🌈 最后，再次感谢你的厚爱与支持！愿你在编程的道路上越走越远，收获满满的成就和喜悦！

关于Python学习指南

---

如果想要系统学习Python、Python问题咨询，或者考虑做一些工作以外的副业，都可以扫描二维码添加微信，围观朋友圈一起交流学习。

我们还为大家准备了Python资料和副业项目合集，感兴趣的小伙伴快来找我领取一起交流学习哦！

学好 Python 不论是就业还是做副业赚钱都不错，但要学会 Python 还是要有一个学习规划。最后给大家分享一份全套的 Python 学习资料，给那些想学习 Python 的小伙伴们一点帮助！

包括：Python激活码+安装包、Python web开发，Python爬虫，Python数据分析，人工智能、自动化办公等学习教程。带你从零基础系统性的学好Python！

👉Python所有方向的学习路线👈

Python所有方向路线就是把Python常用的技术点做整理，形成各个领域的知识点汇总，它的用处就在于，你可以按照上面的知识点去找对应的学习资源，保证自己学得较为全面。（全套教程文末领取）

👉Python学习视频600合集👈

观看零基础学习视频，看视频学习是最快捷也是最有效果的方式，跟着视频中老师的思路，从基础到深入，还是很容易入门的。

温馨提示：篇幅有限，已打包文件夹，获取方式在：文末

👉Python70个实战练手案例&源码👈

光学理论是没用的，要学会跟着一起敲，要动手实操，才能将自己的所学运用到实际当中去，这时候可以搞点实战案例来学习。

👉Python大厂面试资料👈

我们学习Python必然是为了找到高薪的工作，下面这些面试题是来自阿里、腾讯、字节等一线互联网大厂最新的面试资料，并且有阿里大佬给出了权威的解答，刷完这一套面试资料相信大家都能找到满意的工作。

👉Python副业兼职路线&方法👈

学好 Python 不论是就业还是做副业赚钱都不错，但要学会兼职接单还是要有一个学习规划。

👉 这份完整版的Python全套学习资料已经上传，朋友们如果需要可以扫描下方CSDN官方认证二维码或者点击链接免费领取【保证100%免费】

今天的文章 Python入门必学： argparse基本用法分享到此就结束了，感谢您的阅读。