iis服务器助手广告广告
返回顶部
首页 > 资讯 > 后端开发 > Python >python中argparse模块基础及使用步骤
  • 238
分享到

python中argparse模块基础及使用步骤

2024-04-02 19:04:59 238人浏览 八月长安

Python 官方文档:入门教程 => 点击学习

摘要

目录argparse模块用法一、 概念二、 基础1、 使用步骤1.1 总步骤1.2 创建对象1.3 添加参数1.4 解析参数三、 使用案例argparse模块用法 一、 概念 arg

argparse模块用法

一、 概念

argsparse是python的命令行解析的标准模块,内置于Python,不需要安装。这个库可以让我们直接在命令行中就可以向程序中传入参数并让程序运行。

官方文档的位置:【https://docs.python.org/zh-cn/3/library/argparse.html

在这里我们利用git来演示命令行运行

git -h
git -version 
git show

二、 基础

1、 使用步骤

1.1 总步骤

1.导包:
import argparse
2.创建对象:
parser = argparse.ArgumentParser()
3.添加参数:
parser.add_argument()
4.解析参数:
parser.parse_args()

1.2 创建对象

parser = ArgumentParser(prog=None, usage=None,description=None, epilog=None, parents=[],fORMatter_class=argparse.HelpFormatter, prefix_chars='-',fromfile_prefix_chars=None, argument_default=None,conflict_handler='error', add_help=True)

参数说明:

  1. prog:程序的名字,默认为sys.argv[0],用来在help信息中描述程序的名称
  2. usag:描述程序用途的字符串
  3. description:help信息前的文字
  4. epilog:help信息之后的信息
  5. add_help:是否添加帮助信息
  6. prefix_chars:参数前缀,默认为-
  7. fromfile_prefix_chars:前缀字符,放在文件名之前
  8. argument_default:参数的全局默认值
  9. conflict_hander:对冲突的处理方式,默认为返回错误“error”。还有“resolve”,智能解决冲突。当用户给程序添加了两个一样的命令参数时,“error”就直接报错,提醒用户。而“resolve”则会去掉第一次出现的命令参数重复的部分或者全部(可能是短命令冲突或者全都冲突)

1.3 添加参数

add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])

参数说明:

  • name or flags:参数有两种,可选参数和位置参数。parse_args()运行时,会用-来认证可选参数,剩下的即为位置参数。位置参数必选,可选参数可选
# 可选参数
parser.add_argument("-f", "--foo")
# 位置参数
parser.add_argument("bar")  # 位置参数在运行时一定要输入
  • action:动作,argparse内置6种动作可以在解析到一个参数时进行触发
  • store:保存参数值,可能会先将参数值转换成另一个数据类型。默认动作为这个
  • store_const:保存一个被定义为参数规格一部分的值,而不是一个来自参数解析而来的值。这通常用于实现非布尔值的命令行标记
  • stroe_true/store_false:保存相应的布尔值,这两个动作被用于实现布尔开关
  • append:将值保存到一个列表中。若参数重复出现,则保存多个值
  • append_const:将一个定义在参数规格中的值保存到一个列表中
  • version:打印关于程序的版本信息,然后退出
parse.add_argument('--version',action = 'version',version = '%(prog)s2.0')
  • nargs:参数的数量
  • 值可以为整数,*(任意多个),+(一个或更多)
  • 首先从命令行获取参数,若没有则从const获得,然后从default获得
  • dest:参数值就保存为parse_args()返回的命名空间对象中为该dest参数值的一个属性。如果提供dest="a",那么可以通过args.a访问该参数
  • default:设置参数的默认值
  • type:把从命令行输入的结果转成设置的类型
  • choice:允许的参数值
  • requires:是否必选
  • desk:可作为参数名
  • help:参数命令的介绍

参数的几种写法:

python py.py -i 1  # 使用空格分开
python py.py --integer=1  # 长选项使用等号分开
python py.py -i1  # 短选项可以写一起

1.4 解析参数

args = parser.parse_args()  # 括号里面可以传入命令行的参数
args_ = parser.parse_args("-i=1".split("="))

三、 使用案例

我们可以创建一个模板:

#!/usr/bin/env python
# -*- coding: UTF-8 -*-
__author__ = "A.L.Kun"
__file__ = "demo01.py"
__time__ = "2022/6/16 17:12"
__email__ = "liu.zhong.kun@foxmail.com"
from typing import Callable
from functools import wraps
import sys, argparse
def terminal(param: bool = False):  # 判断是否要使用命令行参数
    def get_params(fun: Callable):
        if param:
            parser = argparse.ArgumentParser(description="help document")
            "---------------------------------------------------------------"
			# 如果需要从命令行传入参数时,就在这里添加
            "---------------------------------------------------------------"
            args = parser.parse_args()
        else:
            args = None
        @wraps(fun)
        def inner():
            ret = fun(args)  # 可能在传参数是还要进行其他的初始化操作
            return ret
        return inner
    return get_params
@terminal()  # 使用装饰器
def main(args): 
    print(args)
if __name__ == "__main__":
    main()
    sys.exit(0)

使用案例,创建一个程序,可以连接邮箱的SMTP服务

#!/usr/bin/env python
# -*- coding: UTF-8 -*-
__author__ = "A.L.Kun"
__file__ = "demo01.py"
__time__ = "2022/6/16 17:12"
__email__ = "liu.zhong.kun@foxmail.com"
from smtplib import SMTP
from typing import Callable
from functools import wraps
import sys, argparse
def terminal(param: bool = False):
    def get_params(fun: Callable):
        if param:
            parser = argparse.ArgumentParser(description="help document")
            "---------------------------------------------------------------"
            parser.add_argument('--version', "-v", action='version', version='%(prog)s 2.0')
            parser.add_argument("-u", "--username", type=str, help="Enter the SMTP server account", required=True)
            parser.add_argument("-p", "--passWord", type=str, help="Enter the SMTP server password", required=True)
            "---------------------------------------------------------------"
            args = parser.parse_args()
        else:
            args = None
        @wraps(fun)
        def inner():
            ret = fun(args)
            return ret
        return inner
    return get_params
@terminal(True)
def main(args):
    smtp = SMTP('smtp.qq.com')
    smtp.login(args.username, args.password)
    smtp.quit()
    smtp.close()
if __name__ == "__main__":
    main()
    sys.exit(0)

到此这篇关于python中argparse模块的文章就介绍到这了,更多相关python argparse模块内容请搜索编程网以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程网!

--结束END--

本文标题: python中argparse模块基础及使用步骤

本文链接: https://www.lsjlt.com/news/118821.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑,方便收藏和打印~

下载Word文档
猜你喜欢
  • python中argparse模块基础及使用步骤
    目录argparse模块用法一、 概念二、 基础1、 使用步骤1.1 总步骤1.2 创建对象1.3 添加参数1.4 解析参数三、 使用案例argparse模块用法 一、 概念 arg...
    99+
    2024-04-02
  • python中的argparse基本用法(使用步骤)
    1、argparse是一个python模块,用途是:命令行选项、参数和子命令的解释。 2、使用步骤: 导入argparse模块,并创建解释器添加所需参数解析参数 3、用法示例: im...
    99+
    2023-05-14
    python argparse用法 python argparse使用 python argparse
  • Python argparse库的基本使用步骤
    目录基本用法1、int支持2、str支持3、float支持4、bool支持5、数组支持完整调用argparse库是python下的一个命令行参数管理库,支持int、str、float...
    99+
    2024-04-02
  • python中argparse模块怎么使用
    本篇内容主要讲解“python中argparse模块怎么使用”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“python中argparse模块怎么使用”吧!argparse模块用法一、 概念arg...
    99+
    2023-07-02
  • python的argparse模块如何使用
    这篇文章主要介绍“python的argparse模块如何使用”,在日常操作中,相信很多人在python的argparse模块如何使用问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家解答”python的argparse...
    99+
    2023-07-05
  • python中argparse模块有什么用
    这篇文章将为大家详细讲解有关python中argparse模块有什么用,小编觉得挺实用的,因此分享给大家做个参考,希望大家阅读完这篇文章后可以有所收获。1.argparse模块简介argparse是python标准库里面用来处理命令行参数的...
    99+
    2023-06-02
  • python中argparse模块及action='store_true'详解
    目录Python argparse模块详解1. 问题描述2. add_argument() 方法官方介绍action3. 实例测试与对比 step01step 0...
    99+
    2023-02-10
    python中argparse模块 python action=‘store_true‘
  • python argparse模块传参怎么使用
    这篇文章主要讲解了“python argparse模块传参怎么使用”,文中的讲解内容简单清晰,易于学习与理解,下面请大家跟着小编的思路慢慢深入,一起来研究和学习“python argparse模块传参怎么使用”吧!传入一...
    99+
    2023-06-30
  • python argparse的使用步骤(全网最全)
    目录一、前言二、关于argparse用法常用框架1.获取参数列表2.获取帮助信息3.命令行修改参数4.'_'与"__"的使用5.type的使用6....
    99+
    2023-05-14
    python argparse使用 python argparse用法 python argparse
  • Python基础之模块如何使用
    一、模块模块可以看成是一堆函数的集合体。一个py文件内部就可以放一堆函数,因此一个py文件就可以看成一个模块。如果这个py文件的文件名为module.py,模块名则是module。1、模块的四种形式在Python中,总共有以下四种形式的模块...
    99+
    2023-05-15
    Python
  • Python基础之模块怎么使用
    这篇文章主要介绍“Python基础之模块怎么使用”,在日常操作中,相信很多人在Python基础之模块怎么使用问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家解答”Python基础之模块怎么使用”的疑惑有所帮助!接下来...
    99+
    2023-07-06
  • Python 常用基础模块(二):os模块
    目录 一、os模块介绍二、路径介绍三、常用方法详解3.1 getcwd()方法——获取当前工作目录(字符串)3.2 listdir()方法——返回指定路径下的目录名和文件名3.3 makedi...
    99+
    2023-09-09
    python 开发语言
  • Python中命令行参数argparse模块的使用
    目录传入一个参数位置参数可选参数默认参数必需参数argparse 模块是Python内置的用于命令项选项与参数解析的模块,可以轻松编写友好的命令行接口,能够帮助程序员为模型定义参数。...
    99+
    2023-02-01
    Python argparse模块 Python argparse命令行参数
  • python命令行参数argparse模块基本用法详解
    目录一、传入一个参数二、传入多个参数三、改变数据类型四、可选参数(关键字参数)五、参数默认值六、参数解析补充:python中的argparse基本用法argparse 是p...
    99+
    2023-01-30
    python命令行参数 python命令行参数argparse argparse模块基本用法
  • Python脚本传参数argparse模块的使用
    先上代码举例说明: import argparse   parser = argparse.ArgumentParser()   parser.add_argument("-t", ...
    99+
    2024-04-02
  • python命令行参数模块argparse怎么使用
    今天小编给大家分享一下python命令行参数模块argparse怎么使用的相关知识点,内容详细,逻辑清晰,相信大部分人都还太了解这方面的知识,所以分享这篇文章给大家参考一下,希望大家阅读完这篇文章后有所收获,下面我们一起来了解一下吧。Pyt...
    99+
    2023-07-05
  • Node.js基础模块babel使用详解
    目录安装配置使用babel实际例子类的转化babel-polyfill前言: 由于ES6到ES7增加了很多新的语法,新特性的出现使得大家都希望通过新语法来提升自身的开发效率,但在之前...
    99+
    2024-04-02
  • Node.js基础入门之path模块,url模块,http模块使用详解
    目录path模块1. path模块示例2. path模块其他方法url模块1. 旧的解析方法2. 新的解析方法http模块1. 什么是HTTP协议?2. HTTP协议约束的细节3. ...
    99+
    2024-04-02
  • Node.js基础入门之使用方式及模块化详解
    目录什么是Node.js Node.js下载 Node.js和JavaScript的区别Node.js安装与验证 Node.js使用方式1. REPL模式2. 文...
    99+
    2024-04-02
  • Python dis 模块初步使用
    Python 代码先被编译为字节码后,再由Python虚拟机来执行字节码, Python的字节码是一种类似汇编指令的中间语言, 一个Python语句会对应若干字节码指令,虚拟机一条一条执行字节码指令, 从而完成程序执行。 Python ...
    99+
    2023-01-31
    模块 Python dis
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作