在Python中创建命令行界面的最佳方式

前言:

我们先给大家介绍什么是命令行界面(CLI):

通过创建命令行界面(CLI),可以使程序功能强大并具有交互性。CLI允许您接受命令行参数(操作系统命令行中程序名称后面的信息),以便向程序添加其他特性,使代码易于使用和灵活。根据程序的不同,这些参数可用于添加其他特性,如查看帮助文档、指定输出文件或启用测试特性,这些特性在正常使用时可能会出现问题。

当我们刚开始用Python编程时,我们大多数只收集用户输入,交互方式是这样的:

虽然这段代码对于简单的脚本来说很好,但是这段代码不够灵活。当用户运行这个程序时,它们被限制为一组定义的规则。例如,如果我想将输出记录到文本文件中,该怎么办?作为一个用户,您可以创建一个命令行界面来提供这些问题的解决方案。

重要的注意事项:

在创建CLI时,重要的是要考虑以下几点:

1.必需参数:为了程序的运行,哪些参数是绝对必需的?

2.文档:写出每个选项和参数的函数是很重要的,这样新用户就可以知道你的程序是如何工作的。

3.处理错误情况:让用户确切地知道哪里出了问题

4.运行时状态:如果任务没有立即完成,您应该打印出当前的进度

使用argparse读取参数:

Argparse是一个用于解析命令行参数的Python标准库模块。作为程序员,您可以定义要接受的参数,而argparse将知道如何从sys中解析这些参数。当用户给程序提供无效参数时,Argparse还会自动生成帮助和使用消息,并输出错误。它使用起来非常简单,并且可以很容易地编写直观的CLI。

首先,创建一个名为test_cl .py的新文件,导入模块并初始化一个新的解析器:

现在使用--help选项运行代码:

你应该会收到一个很好的默认帮助信息,像这样:

祝贺您创建了第一个命令行界面!

现在让我们添加一个欢迎消息,简要地让您的用户知道这个程序是做什么的:

现在用-h标志运行程序。你应该可以看到你的欢迎信息。

添加参数:

假设我们正在编写一个程序来爬一个网页。我们可能需要的一些参数是网页的域-domain或-d,日志输出到一个输出文件-ofile或-o的选项,可能还需要输出到控制台的特定行数-lines或-l的选项。对于这个例子,我们将域参数设置为必需的,而ofile和lines参数将是可选的。

通过使用.add_argument,我们可以很容易地向argparse CLI添加额外的参数,该参数允许我们定义使用细节。我们可以添加必要的参数——域,如:

现在运行带有-h参数的程序,查看您编写的文档!

因为——domain是一个必需的参数,尝试运行不带任何标志的程序,您将收到以下消息:

Python作为一门不断发展与普及的语言,还在不断更新中。在学习时,建议找一些学习伙伴一起来学习和讨论,效果更佳。如果想学习Python,欢迎加入Python学习交流群(627012464),一起督促,一起学习。里面有开发工具,很多干货和技术资料分享!

成功了!

现在使用argparse添加额外的参数。如果没有指定需要哪些参数,argparse将假定它们是可选的。你也可以设置参数的类型,对于——lines,我们取一个整数。您还可以为.add_argument设置其他有用的选项——比如action=

现在测试您的代码,以确保一切正常运行。一种简单的方法是将参数的值存储为变量,然后打印这些值。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,539评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,594评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,871评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,963评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,984评论 6 393
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,763评论 1 307
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,468评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,357评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,850评论 1 317
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,002评论 3 338
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,144评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,823评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,483评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,026评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,150评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,415评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,092评论 2 355

推荐阅读更多精彩内容