备案控制台
探索云世界
开发者社区 开发与运维 文章 正文

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

2017-11-13 1305
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 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 argparse
Python实现
郭大瘦
目录
相关文章
1941623231718325
|
17天前
|
存储 开发者 Python
Python中的collections模块与UserDict：用户自定义字典详解
【4月更文挑战第2天】在Python中，`collections.UserDict`是用于创建自定义字典行为的基类，它提供了一个可扩展的接口。通过继承`UserDict`，可以轻松添加或修改字典功能，如在`__init__`和`__setitem__`等方法中插入自定义逻辑。使用`UserDict`有助于保持代码可读性和可维护性，而不是直接继承内置的`dict`。例如，可以创建一个`LoggingDict`类，在设置键值对时记录操作。这样，开发者可以根据具体需求定制字典行为，同时保持对字典内部管理的抽象。
1941623231718325
21 0
1941623231718325
|
18天前
|
存储 缓存 算法
Python中collections模块的deque双端队列：深入解析与应用
在Python的`collections`模块中，`deque`（双端队列）是一个线程安全、快速添加和删除元素的双端队列数据类型。它支持从队列的两端添加和弹出元素，提供了比列表更高的效率，特别是在处理大型数据集时。本文将详细解析`deque`的原理、使用方法以及它在各种场景中的应用。
1941623231718325
28 4
find_starshine
|
3天前
|
Python
python学习14-模块与包
python学习14-模块与包
find_starshine
18 0
1941623231718325
|
5天前
|
SQL 关系型数据库 数据库
Python中SQLite数据库操作详解：利用sqlite3模块
【4月更文挑战第13天】在Python编程中，SQLite数据库是一个轻量级的关系型数据库管理系统，它包含在一个单一的文件内，不需要一个单独的服务器进程或操作系统级别的配置。由于其简单易用和高效性，SQLite经常作为应用程序的本地数据库解决方案。Python的内置sqlite3模块提供了与SQLite数据库交互的接口，使得在Python中操作SQLite数据库变得非常容易。
1941623231718325
14 5
雪梅零落
|
10天前
|
索引 Python
「Python系列」Python operator模块、math模块
Python的`operator`模块提供了一系列内置的操作符函数，这些函数对应于Python语言中的内建操作符。使用`operator`模块可以使代码更加清晰和易读，同时也能提高性能，因为它通常比使用Python内建操作符更快。
雪梅零落
27 0
1941623231718325
|
14天前
|
数据采集 网络协议 API
python中其他网络相关的模块和库简介
【4月更文挑战第4天】Python网络编程有多个流行模块和库，如requests提供简洁的HTTP客户端API，支持多种HTTP方法和自动处理复杂功能；Scrapy是高效的网络爬虫框架，适用于数据挖掘和自动化测试；aiohttp基于asyncio的异步HTTP库，用于构建高性能Web应用；Twisted是事件驱动的网络引擎，支持多种协议和异步编程；Flask和Django分别是轻量级和全栈Web框架，方便构建不同规模的Web应用。这些工具使网络编程更简单和高效。
1941623231718325
16 6
1941623231718325
|
18天前
|
数据采集 数据挖掘 Python
Python中collections模块的Counter计数器：深入解析与应用
在Python的`collections`模块中，`Counter`是一个强大且实用的工具，它主要用于计数可哈希对象。无论是统计单词出现的频率，还是分析数据集中元素的分布情况，`Counter`都能提供快速且直观的结果。本文将深入解析`Counter`计数器的原理、用法以及它在实际应用中的价值。
1941623231718325
15 3
1941623231718325
|
19天前
|
Python
Python中的math和cmath模块：数学运算的得力助手
Python作为一种功能强大的编程语言，提供了丰富的数学运算功能。其中，math和cmath模块就是Python中用于数学运算的重要工具。math模块提供了基本的数学函数和常量，适用于实数运算；而cmath模块则提供了对复数运算的支持，使得Python在数学计算和工程应用中更加灵活和强大。
1941623231718325
17 0
TesterMuller
|
22天前
|
数据挖掘 Python
Python中的datetime模块：轻松拿捏时间操作
Python的`datetime`模块是处理日期和时间的核心工具，包括`date`、`time`、`datetime`、`timedelta`类。它可以创建、操作和格式化日期时间。
TesterMuller
19 2
Python编程
|
24天前
|
Python
Python random模块（获取随机数）常用方法和使用例子
`random`模块在Python中用于生成随机数。
Python编程
20 0

热门文章

最新文章

  • 1
    【Python 基础教程 02】 数据类型全解析：从基础到高级，实用指南及详细使用案例
  • 2
    【Python 基础教程 01 全面介绍】 Python编程基础全攻略：一文掌握Python语法精髓，从C/C++ 角度学习Python的差异
  • 3
    使用Python实现DBSCAN聚类算法
  • 4
    在Python Web开发过程中：数据库与缓存，MySQL和NoSQL数据库的主要差异是什么？
  • 5
    Redis与Python的完美结合：实现高效数据交互和应用场景全解析
  • 6
    【Python 基础教程 23】Python3 错误与异常处理全面指南：从入门到精通的实用教程
  • 7
    Python读取.nc文件的方法与技术详解
  • 8
    Pandas基本操作：Series和DataFrame（Python）
  • 9
    【Python 基础教程 运算符06】Python3运算符超详细解析：全面入门教程，初学者必读
  • 10
    【Python 基础教程 05】超详细解析Python3注释：全面入门教程，初学者必读,了解Python如何 进行注释
  • 1
    Python中的装饰器：概念、用法和实例
    18
  • 2
    Python中的装饰器：概念、用法及实例
    17
  • 3
    使用Python实现图像处理中的边缘检测算法
    39
  • 4
    Python中如何实现字符串反转？请提供至少两种方法。
    17
  • 5
    请简述Python中的继承、封装和多态的概念。
    22
  • 6
    在Python中，如何创建一个迭代器？
    19
  • 7
    请解释Python中的迭代器和生成器的区别？并分别举例说明。
    17
  • 8
    在Python中，如何使用装饰器重写类的方法？
    21
  • 9
    Python中的装饰器是什么？请举例说明其用法。
    19
  • 10
    Python中的装饰器：概念、用法及实例
    17

    • 相关课程

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

    • 相关电子书

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

    • 相关实验场景

    更多
  • Python新手入门
  • Python入门
  • Python选择及循环结构
  • Python新手入门（Anolis OS）
  • Python网络通信程序典型应用
    • 下一篇
    阿里云oss简介和使用流程
    为什么选择阿里云什么是云计算全球基础设施技术领先稳定可靠安全合规分析师报告
    产品和定价全部产品免费试用产品动态产品定价价格计算器云上成本管理
    解决方案技术解决方案
    文档与社区文档开发者社区天池大赛培训与认证
    权益中心免费试用高校计划企业扶持计划推荐返现计划
    支持与服务基础服务企业增值服务迁云服务官网公告健康看板信任中心
    关注阿里云
    关注阿里云公众号或下载阿里云APP，关注云资讯，随时随地运维管控云服务
    阿里云APP阿里云微信
    联系我们：4008013260
    法律声明Cookies政策廉正举报安全举报联系我们加入我们
    阿里巴巴集团淘宝网天猫全球速卖通阿里巴巴国际交易市场1688阿里妈妈飞猪阿里云计算AliOS万网高德UC友盟优酷钉钉支付宝达摩院淘宝海外阿里云盘饿了么
    © 2009-2024 Aliyun.com 版权所有 增值电信业务经营许可证： 浙B2-20080101 域名注册服务机构许可： 浙D3-20210002 京D3-20220015
    浙公网安备 33010602009975号浙B2-20080101-4