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

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

2017-11-13 1330
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 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命令行
模块Python命令行
郭大瘦
目录
相关文章
vohelon
|
8天前
|
Python
在Python中，可以使用内置的`re`模块来处理正则表达式
在Python中，可以使用内置的`re`模块来处理正则表达式
vohelon
20 5
kaixin321-44007
|
18天前
|
Java 程序员 开发者
Python的gc模块
Python的gc模块
kaixin321-44007
16 2
Ly001122
|
21天前
|
数据采集 Web App开发 JavaScript
python-selenium模块详解！！！
Selenium 是一个强大的自动化测试工具，支持 Python 调用浏览器进行网页抓取。本文介绍了 Selenium 的安装、基本使用、元素定位、高级操作等内容。主要内容包括：发送请求、加载网页、元素定位、处理 Cookie、无头浏览器设置、页面等待、窗口和 iframe 切换等。通过示例代码帮助读者快速掌握 Selenium 的核心功能。
Ly001122
64 5
张志凌
|
20天前
|
Python
SciPy 教程 之 SciPy 模块列表 16
SciPy教程之SciPy模块列表16 - 单位类型。常量模块包含多种单位，如公制、质量、角度、时间、长度、压强、体积、速度、温度、能量、功率和力学单位。示例代码展示了力学单位的使用，如牛顿、磅力和千克力等。
张志凌
15 0
张志凌
|
21天前
|
JavaScript Python
SciPy 教程 之 SciPy 模块列表 15
SciPy 教程之 SciPy 模块列表 15 - 功率单位。常量模块包含多种单位，如公制、质量、时间等。功率单位中，1 瓦特定义为 1 焦耳/秒，表示每秒转换或耗散的能量速率。示例代码展示了如何使用 `constants` 模块获取马力值（745.6998715822701）。
张志凌
15 0
张志凌
|
21天前
|
JavaScript Python
SciPy 教程 之 SciPy 模块列表 15
SciPy教程之SciPy模块列表15：单位类型。常量模块包含多种单位，如公制、质量、角度、时间、长度、压强、体积、速度、温度、能量、功率和力学单位。功率单位以瓦特（W）表示，1W=1J/s。示例代码展示了如何使用`constants`模块获取马力（hp）的值，结果为745.6998715822701。
张志凌
16 0
张志凌
|
22天前
|
Python
SciPy 教程 之 SciPy 模块列表 13
SciPy 教程之 SciPy 模块列表 13 - 单位类型。常量模块包含多种单位：公制、二进制（字节）、质量、角度、时间、长度、压强、体积、速度、温度、能量、功率和力学单位。示例：`constants.zero_Celsius` 返回 273.15 开尔文，`constants.degree_Fahrenheit` 返回 0.5555555555555556。
张志凌
14 0
游客qf4jmczx4xu2y
|
6天前
|
机器学习/深度学习 人工智能 TensorFlow
人工智能浪潮下的自我修养：从Python编程入门到深度学习实践
【10月更文挑战第39天】本文旨在为初学者提供一条清晰的道路，从Python基础语法的掌握到深度学习领域的探索。我们将通过简明扼要的语言和实际代码示例，引导读者逐步构建起对人工智能技术的理解和应用能力。文章不仅涵盖Python编程的基础，还将深入探讨深度学习的核心概念、工具和实战技巧，帮助读者在AI的浪潮中找到自己的位置。
游客qf4jmczx4xu2y
29 6
天下无贼001
|
6天前
|
机器学习/深度学习 数据挖掘 Python
Python编程入门——从零开始构建你的第一个程序
【10月更文挑战第39天】本文将带你走进Python的世界，通过简单易懂的语言和实际的代码示例，让你快速掌握Python的基础语法。无论你是编程新手还是想学习新语言的老手，这篇文章都能为你提供有价值的信息。我们将从变量、数据类型、控制结构等基本概念入手，逐步过渡到函数、模块等高级特性，最后通过一个综合示例来巩固所学知识。让我们一起开启Python编程之旅吧！
天下无贼001
21 1
aliyun8599273441-30642
|
6天前
|
存储 Python
Python编程入门：打造你的第一个程序
【10月更文挑战第39天】在数字时代的浪潮中，掌握编程技能如同掌握了一门新时代的语言。本文将引导你步入Python编程的奇妙世界，从零基础出发，一步步构建你的第一个程序。我们将探索编程的基本概念，通过简单示例理解变量、数据类型和控制结构，最终实现一个简单的猜数字游戏。这不仅是一段代码的旅程，更是逻辑思维和问题解决能力的锻炼之旅。准备好了吗？让我们开始吧！
aliyun8599273441-30642
104 50

热门文章

最新文章

  • 1
    手把手教你用Python实践深度学习
  • 2
    3、Python与设计模式--建造者模式
  • 3
    Python 阿里云盾滑块验证
  • 4
    python 合并当天tomcat异常日志
  • 5
    python第三节课堂练习：统计一句单词
  • 6
    python类的使用
  • 7
    [PYTHON] 核心编程笔记之二-Python起步
  • 8
    python对比配置文件差异
  • 9
    Python基础教程笔记——条件，循环和其他语句
  • 10
    Python中参数多个值的表示法
  • 1
    利用 python 分析基金，合理分析数据让赚钱赢在起跑线！(1)
    60
  • 2
    Python中return和yield的区别，面试官不讲武德
    50
  • 3
    python函数参数的传递、带星号参数的传递，2024年大厂Python高级面试题分享
    44
  • 4
    实时计算 Flink版产品使用合集之怎么热加载Java和Python的UDF
    77
  • 5
    学会Python自动制作Word，将看到一个5天4位数的赚钱机会
    45
  • 6
    使用Python和Twilio通过短信通知主持视频办公时间。
    37
  • 7
    Python 中下划线的 6 个作用(1)，【干货】
    47
  • 8
    vscode打造舒适的python开发环境
    83
  • 9
    Python----matplotlib库
    67
  • 10
    使用Python实现深度学习模型：生成对抗网络（GAN）
    142

    • 相关课程

    更多
  • 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
    • 下一篇
    阿里云OSS设置跨域访问