【Python】argparse解析命令行参数模块

举报
开心星人 发表于 2022/11/22 20:33:30 2022/11/22
【摘要】 内容均来自这两篇https://blog.csdn.net/edc3001/article/details/113788716https://blog.csdn.net/qq_41731861/article/details/120827681先看一个GitHack的使用argparse的小栗子import argparseparser = argparse.ArgumentParser(d...

内容均来自这两篇
https://blog.csdn.net/edc3001/article/details/113788716
https://blog.csdn.net/qq_41731861/article/details/120827681

先看一个GitHack的使用argparse的小栗子

import argparse
parser = argparse.ArgumentParser(description='GitHacker')
group = parser.add_mutually_exclusive_group(required=True)
group.add_argument('--url', help='url of the target website which expose `.git` folder')
group.add_argument('--url-file', help='url file that contains a list of urls of the target website which expose `.git` folder')
parser.add_argument('--output-folder', required=True, help='the local folder which will be the parent folder of all exploited repositories, every repo will be stored in folder named md5(url).')
parser.add_argument('--brute', required=False, default=False, help='enable brute forcing branch/tag names', action='store_true')
parser.add_argument('--enable-manually-check-dangerous-git-files', required=False, default=False, help='disable manually check dangerous git files which may lead to *RCE* (eg: .git/config, .git/hook/pre-commit) when downloading malicious .git folders. If this argument is given, GitHacker will not download the files which may be dangerous at all.', action='store_true')
parser.add_argument('--threads', required=False, default=0x04, type=int, help='threads number to download from internet')
parser.add_argument('--version', action='version')
args = parser.parse_args()

在这里插入图片描述

argparse是一个用来解析命令行参数的 Python 库。argparse 模块使编写用户友好的命令行界面变得容易。程序定义了所需的参数,而 argparse 将找出如何从 sys.argv (命令行)中解析这些参数。argparse 模块还会自动生成帮助和使用消息,并在用户为程序提供无效参数时发出错误。

  • 导入argparse包;
  • 创建ArgumentParser()参数对象;
  • 调用add_argument()方法往参数对象中添加参数;
  • 使用parse_args()解析添加参数的参数对象,获得解析对象;程序的其他部分需要使用命令行参数时,用解析对象.参数获取。

命令行参数输入默认按顺序赋值,顺序不同会造成结果不同;
默认命令-h可以获取添加参数时设置的帮助信息;

可选参数

parse.add_argument('--radius', default=2, type=int, help='Radius of Cylinder')

通过在参数名前加–,设置为可选参数。如果未输入,则使用default默认值(若未设置default,则会默认赋值None)。

可选参数引用名

parse.add_argument('-r', '--radius', default=2, type=int, help='Radius of Cylinder')

通过将可选参数设置引用名,可以缩短参数名-r,简化命令行参数输入。

清除帮助中的参数名信息

parse.add_argument('-r', '--radius', default=2, type=int, metavar='', help='Radius of Cylinder')

metavar在通过-h显示usage 明中的参数名称,对于必选参数默认就是参数名称,对于可选参数默认是全大写的参数名称。这里通过设置为空一律不显示。

必选参数设置

parse.add_argument('-r', '--radius', default=2, type=int, metavar='', required=True, help='Radius of Cylinder')

当通过设置required=True后,无论参数是否是可选参数,都必须输入。

列表参数(多参数)传入设置

def parse_args():
    parse = argparse.ArgumentParser(description='Calculate cylinder volume')
    parse.add_argument('-n', '--num', type=int, nargs='+', metavar='', required=True, help='a string of nums')
    args = parse.parse_args()
    return args

互斥参数使用

1、在参数对象中添加互斥组

group = parse.add_mutually_exclusive_group()  

2、在互斥组中添加参数(store_true默认当命令行未输入参数则为False,否则为True)

group.add_argument('-b', '--brief', action='store_true', help='print brief message')  
group.add_argument('-v', '--verbose', action='store_true', help='print verbose message')

命令行中b和v只能输入二者中的一个参数。

默认参数设置

parse.set_defaults(height=4)

set_defaults()可以设置一些参数的默认值。

add_argument参数总结

  • action - 命令行遇到参数时的动作,默认值是 store。
    – store_const,表示赋值为const;
    – append,将遇到的值存储成列表,也就是如果参数重复则会保存多个值;
    – append_const,将参数规范中定义的一个值保存到一个列表;
    – count,存储遇到的次数;此外,也可以继承 argparse.Action 自定义参数解析;

  • nargs - 应该读取的命令行参数个数,可以是
    具体的数字,或者是?号,当不指定值时对于 Positional argument 使用 default,对于 Optional argument 使用 const
    或者是 * 号,表示 0 或多个参数;
    或者是 + 号表示 1 或多个参数。

  • default - 不指定参数时的默认值。

  • type - 命令行参数应该被转换成的类型。

  • required - 可选参数是否可以省略 (仅针对可选参数)。

  • metavar - 在 usage 说明中的参数名称,对于必选参数默认就是参数名称,对于可选参数默认是全大写的参数名称.

  • dest - 解析后的参数名称,默认情况下,对于可选参数选取最长的名称,中划线转换为下划线.

【版权声明】本文为华为云社区用户原创内容,转载时必须标注文章的来源(华为云社区)、文章链接、文章作者等基本信息, 否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

评论(0

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。