AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

Argparse模块:python快捷实现命令行操作

2017-11-13 1334
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： python中的argparse模块可以方便地实现命令行解释操作，从而实现丰富的功能接口。首先我们来看一段Shell代码：$ lscpython devguide prog.

python中的argparse模块可以方便地实现命令行解释操作，从而实现丰富的功能接口。

首先我们来看一段Shell代码：

$ ls
cpython  devguide  prog.py  pypy  rm-unused-function.patch
$ ls pypy
ctypes_configure  demo  dotviewer  include  lib_pypy  lib-python ...
$ ls -l
total 20
drwxr-xr-x 19 wena wena 4096 Feb 18 18:51 cpython
drwxr-xr-x  4 wena wena 4096 Feb  8 12:04 devguide
-rwxr-xr-x  1 wena wena  535 Feb 19 00:05 prog.py
drwxr-xr-x 14 wena wena 4096 Feb  7 00:59 pypy
-rw-r--r--  1 wena wena  741 Feb 18 01:01 rm-unused-function.patch
$ ls --help
Usage: ls [OPTION]... [FILE]...
List information about the FILEs (the current directory by default).
Sort entries alphabetically if none of -cftuvSUX nor --sort is specified.
...

接触过linux的人都知道，上面的一段代码中使用了‘ls’这个命令行参数，这个‘ls’命令对于linux使用者是经常使用的。
从中上面的使用中我们可以看到：
1、如果我们只使用‘ls’这个命令，则默认显示当前目录中的内容；
2、如果你想要执行这个命令行的其他功能，比如你要显示另一个目录pypy。这里我们要注意的就是“位置参数”（positional argument）。正如第二个命令显示，‘ls pypy’，‘pypy’是‘ls’命令的位置参数，用于告诉这个命令具体要做什么；
3、现在我们想要显示更多的信息，而不是光光显示内容的名字，于是我们在后面加了一个‘-l’，这个参数则称为“可选参数”；
4、‘–help’则帮助你了解这个命令怎么使用。

好了，回到python来吧，首先我们导入模块。

基本操作

import argparse
parser = argparse.ArgumentParser()
parser.parse_args()

写好上面的程序后，在终端中输入：

$ python3 prog.py
$ python3 prog.py --help
usage: prog.py [-h]

optional arguments:
  -h, --help  show this help message and exit
$ python3 prog.py --verbose
usage: prog.py [-h]
prog.py: error: unrecognized arguments: --verbose
$ python3 prog.py foo
usage: prog.py [-h]
prog.py: error: unrecognized arguments: foo
Here is what is happening:

第一行，仅仅运行这个脚本没有什么实质用处。
第二行就展示了argparse module的作用，我们得到了一个不错的帮助信息。
很容易知道“–help”和’-h’功能相同，这个可选参数在初始化后就存在，不用自个儿写。
第三个和第四个命令显然是错的，因为啥也没写，故会报错。

现在进行修改：

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("echo")
args = parser.parse_args()
print(args.echo)            #执行该脚本时前台显示代码

执行以下命令：

$ python3 prog.py
usage: prog.py [-h] echo
prog.py: error: the following arguments are required: echo
$ python3 prog.py --help
usage: prog.py [-h] echo

positional arguments:
  echo

optional arguments:
  -h, --help  show this help message and exit
$ python3 prog.py foo
foo

上面程序中，加入了 add_argument() 方法，用来确认我们想使用什么样的命令行可选参数。上面程序中加入了“echo”参数，另外parse_args()方法一般用于从确定使用的“可选参数”功能中返回数据，在这个例子中是返回echo。

再次修改，

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("echo", help="echo the string you use here")
args = parser.parse_args()
print(args.echo)

然后得到：

$ python3 prog.py -h
usage: prog.py [-h] echo

positional arguments:
  echo        echo the string you use here

optional arguments:
  -h, --help  show this help message and exit

再加进一步：


import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", help="display a square of a given number")
args = parser.parse_args()
print(args.square**2)
Following is a result of running the code:

$ python3 prog.py 4
Traceback (most recent call last):
  File "prog.py", line 5, in <module>
    print(args.square**2)
TypeError: unsupported operand type(s) for ** or pow(): 'str' and 'int'

这样直接进行操作会发生错误，因为模块默认将输入的参数识别为string类型，我们只有明确表明为int型才可以进行**操作。

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", help="display a square of a given number",
                    type=int)
args = parser.parse_args()
print(args.square**2)

然后看结果：

$ python3 prog.py 4
16
$ python3 prog.py four
usage: prog.py [-h] square
prog.py: error: argument square: invalid int value: 'four'

接下来介绍“可选”参数：

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("--verbosity", help="increase output verbosity")
args = parser.parse_args()
if args.verbosity:     #当不使用--verbosity时，该参数为None
    print("verbosity turned on"）

输出：

$ python3 prog.py --verbosity 1
verbosity turned on
$ python3 prog.py
$ python3 prog.py --help
usage: prog.py [-h] [--verbosity VERBOSITY]

optional arguments:
  -h, --help            show this help message and exit
  --verbosity VERBOSITY
                        increase output verbosity
$ python3 prog.py --verbosity
usage: prog.py [-h] [--verbosity VERBOSITY]
prog.py: error: argument --verbosity: expected one argument

上面的一段程序用来展示一些东西，当–verbosity被确定时就会打印出信息，如果没有则什么也不显示，另外要有些需要修改的地方：1、程序的帮助信息有些歧义，2、verbosity只需要两个状态就可以工作了：Ture和False。

进行修改：

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("--verbose", help="increase output verbosity",
                    action="store_true")
args = parser.parse_args()
if args.verbose:
    print("verbosity turned on")

输出：

$ python3 prog.py --verbose
verbosity turned on
$ python3 prog.py --verbose 1
usage: prog.py [-h] [--verbose]
prog.py: error: unrecognized arguments: 1
$ python3 prog.py --help
usage: prog.py [-h] [--verbose]

optional arguments:
  -h, --help  show this help message and exit
  --verbose   increase output verbosity

修改后，这个选项更像一个标志而不是获取一个值了。注意我们加了一个新的关键字：action，然后给了它一个参数”store_true”。这样的话，当选项被确定的时候，args.verbose被确定为True。不使用选项则为False。

当然也可以使用短的选项参数：

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("-v", "--verbose", help="increase output verbosity",
                    action="store_true")
args = parser.parse_args()
if args.verbose:
    print("verbosity turned on")

输出：

$ python3 prog.py -v
verbosity turned on
$ python3 prog.py --help
usage: prog.py [-h] [-v]

optional arguments:
  -h, --help     show this help message and exit
  -v, --verbose  increase output verbosity

将位置参数和可选参数进行结合：

i

mport argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display a square of a given number")
parser.add_argument("-v", "--verbose", action="store_true",
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbose:
    print("the square of {} equals {}".format(args.square, answer))
else:
    print(answer)

输出：

$ python3 prog.py
usage: prog.py [-h] [-v] square
prog.py: error: the following arguments are required: square
$ python3 prog.py 4
16
$ python3 prog.py 4 --verbose
the square of 4 equals 16
$ python3 prog.py --verbose 4
the square of 4 equals 16

上面程序中重新加上了位置参数，如果使用时不明确使用位置参数则会出现错误。
下面则使用了多可选参数的设置。

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display a square of a given number")
parser.add_argument("-v", "--verbosity", type=int,
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbosity == 2:
    print("the square of {} equals {}".format(args.square, answer))
elif args.verbosity == 1:
    print("{}^2 == {}".format(args.square, answer))
else:
    print(answer)

输出：

$ python3 prog.py 4
16
$ python3 prog.py 4 -v
usage: prog.py [-h] [-v VERBOSITY] square
prog.py: error: argument -v/--verbosity: expected one argument
$ python3 prog.py 4 -v 1
4^2 == 16
$ python3 prog.py 4 -v 2
the square of 4 equals 16
$ python3 prog.py 4 -v 3
16

上面输出中最后一行有点小问题，修改一下：

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display a square of a given number")
parser.add_argument("-v", "--verbosity", type=int, choices=[0, 1, 2],
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbosity == 2:
    print("the square of {} equals {}".format(args.square, answer))
elif args.verbosity == 1:
    print("{}^2 == {}".format(args.square, answer))
else:
    print(answer)

输出：

$ python3 prog.py 4 -v 3
usage: prog.py [-h] [-v {0,1,2}] square
prog.py: error: argument -v/--verbosity: invalid choice: 3 (choose from 0, 1, 2)
$ python3 prog.py 4 -h
usage: prog.py [-h] [-v {0,1,2}] square

positional arguments:
  square                display a square of a given number

optional arguments:
  -h, --help            show this help message and exit
  -v {0,1,2}, --verbosity {0,1,2}
                        increase output verbosity

参考资料：https://docs.python.org/3/howto/argparse.html#id1

文章标签：
Python
Shell
Linux
关键词：
Python模块
模块Python
Python命令行
Python argparse
模块Python命令行
郭大瘦
目录
相关文章
dufadayang
|
2月前
|
开发者 Python
如何在Python中管理模块和包的依赖关系？
在实际开发中，通常会结合多种方法来管理模块和包的依赖关系，以确保项目的顺利进行和可维护性。同时，要及时更新和解决依赖冲突等问题，以保证代码的稳定性和可靠性
dufadayang
55 4
米果粒
|
18天前
|
Python
Python Internet 模块
Python Internet 模块。
米果粒
117 74
bruce_xiaowei
|
2月前
|
算法 数据安全/隐私保护 开发者
马特赛特旋转算法：Python的随机模块背后的力量
马特赛特旋转算法是Python `random`模块的核心，由松本真和西村拓士于1997年提出。它基于线性反馈移位寄存器，具有超长周期和高维均匀性，适用于模拟、密码学等领域。Python中通过设置种子值初始化状态数组，经状态更新和输出提取生成随机数，代码简单高效。
bruce_xiaowei
117 63
我是快乐的嘟嘟
|
2月前
|
测试技术 Python
手动解决Python模块和包依赖冲突的具体步骤是什么？
需要注意的是，手动解决依赖冲突可能需要一定的时间和经验，并且需要谨慎操作，避免引入新的问题。在实际操作中，还可以结合使用其他方法，如虚拟环境等，来更好地管理和解决依赖冲突😉。
我是快乐的嘟嘟
121 58
我是快乐的嘟嘟
|
2月前
|
持续交付 Python
如何在Python中自动解决模块和包的依赖冲突？
完全自动解决所有依赖冲突可能并不总是可行，特别是在复杂的项目中。有时候仍然需要人工干预和判断。自动解决的方法主要是提供辅助和便捷，但不能完全替代人工的分析和决策😉。
我是快乐的嘟嘟
136 49
dufadayang
|
2月前
|
Python
Python的模块和包
总之，模块和包是 Python 编程中非常重要的概念，掌握它们可以帮助我们更好地组织和管理代码，提高开发效率和代码质量
dufadayang
44 5
我是快乐的嘟嘟
|
2月前
|
数据可视化 Python
如何在Python中解决模块和包的依赖冲突？
解决模块和包的依赖冲突需要综合运用多种方法，并且需要团队成员的共同努力和协作。通过合理的管理和解决冲突，可以提高项目的稳定性和可扩展性
我是快乐的嘟嘟
82 3
游客qf4jmczx4xu2y
|
28天前
|
人工智能 数据可视化 数据挖掘
探索Python编程：从基础到高级
在这篇文章中，我们将一起深入探索Python编程的世界。无论你是初学者还是有经验的程序员，都可以从中获得新的知识和技能。我们将从Python的基础语法开始，然后逐步过渡到更复杂的主题，如面向对象编程、异常处理和模块使用。最后，我们将通过一些实际的代码示例，来展示如何应用这些知识解决实际问题。让我们一起开启Python编程的旅程吧！
游客qf4jmczx4xu2y
63 5
游客moiomvrp3vyac2
|
27天前
|
存储 数据采集 人工智能
Python编程入门：从零基础到实战应用
本文是一篇面向初学者的Python编程教程，旨在帮助读者从零开始学习Python编程语言。文章首先介绍了Python的基本概念和特点，然后通过一个简单的例子展示了如何编写Python代码。接下来，文章详细介绍了Python的数据类型、变量、运算符、控制结构、函数等基本语法知识。最后，文章通过一个实战项目——制作一个简单的计算器程序，帮助读者巩固所学知识并提高编程技能。
游客moiomvrp3vyac2
83 2
overmind1980
|
16天前
|
Unix Linux 程序员
[oeasy]python053_学编程为什么从hello_world_开始
视频介绍了“Hello World”程序的由来及其在编程中的重要性。从贝尔实验室诞生的Unix系统和C语言说起，讲述了“Hello World”作为经典示例的起源和流传过程。文章还探讨了C语言对其他编程语言的影响，以及它在系统编程中的地位。最后总结了“Hello World”、print、小括号和双引号等编程概念的来源。
overmind1980
102 80

热门文章

最新文章

  • 1
    使用Python实现智能食品库存管理的深度学习模型
  • 2
    Python实现常用办公文件格式转换
  • 3
    猫狗宠物识别系统Python+TensorFlow+人工智能+深度学习+卷积网络算法
  • 4
    pyenv 管理多个 Python 版本(1)
  • 5
    Python编程数据结构的深入理解
  • 6
    Python的标准库
  • 7
    利用Python内置函数实现的冒泡排序算法
  • 8
    使用Python实现智能食品消费习惯分析的深度学习模型
  • 9
    使用Python实现深度学习模型的分布式训练
  • 10
    在 Python 中，如何将日期时间类型转换为字符串？
  • 1
    Python 密码学实用指南（全）（2）
    44
  • 2
    【python】习题 第10周
    63
  • 3
    【python】习题第8周
    62
  • 4
    【python】习题第7周（上）
    94
  • 5
    【python】习题 6-10周（下）
    63
  • 6
    【python】习题 6-10周（中）
    67
  • 7
    Python 入门指南（七）（4）
    52
  • 8
    【python】习题 1-5周（中）
    96
  • 9
    【python】习题 1-5周（上）
    55
  • 10
    Python 入门指南（七）（2）
    63

    • 相关课程

    更多
  • Python爬虫实战
  • Python开发基础入门
  • Python常用数据科学库
  • Python网络爬虫实战
  • Python完全自学手册图文教程
  • Python基础快速入门实战教程

    • 相关电子书

    更多
  • From Python Scikit-Learn to Sc
  • Data Pre-Processing in Python:
  • 双剑合璧-Python和大数据计算平台的结合

    • 相关实验场景

    更多
  • 用Python画圣诞树
  • Python选择及循环结构
  • 云端Python及基本操作
  • Python网络通信程序典型应用
  • Python新手入门（Anolis OS）
  • Python新手入门

    • 推荐镜像

    更多
  • python-release
  • nodejs-release
  • golang
    • 下一篇
    阿里云无影云电脑免费试用，最长可试用3个月