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

前言：

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

命令行界面或命令语言解释器，也称为命令行用户界面、控制台用户界面和字符用户界面，是一种与计算机程序交互的方式，用户以连续的文本行形式向程序发出命令。

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

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

def main():
    first = input(“Enter your first name:”)
    last = input(“Enter your last name:”)
    print(first + ' ' + last)

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

重要的注意事项：

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

必需参数:为了程序的运行，哪些参数是绝对必需的?
文档:写出每个选项和参数的函数是很重要的，这样新用户就可以知道你的程序是如何工作的。
处理错误情况:让用户确切地知道哪里出了问题
运行时状态:如果任务没有立即完成，您应该打印出当前的进度

使用argparse读取参数：

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

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

import argparse
parser = argparse.ArgumentParser()
parser.parse_args()

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

python3 test_cli.py --help

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

usage: test_cli.py [-h]
optional arguments:
    -h, --help  show this help message and exit

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

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

welcome = "Practicing creating interactive command-line interfaces"
parser = argparse.ArgumentParser(description=welcome)
parser.parse_args()

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

添加参数：

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

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

parser.add_argument('--domain', '-d', required=True, help='domain name of the website you want to scrape. i.e. “https://ahadsheriff.com"')

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

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

usage: test_cli.py [-h] --domain DOMAIN
test_cli.py: error: the following arguments are required: --domain/-d

成功了！

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

parser.add_argument('--ofile', '-o', help='define output file to save results of stdout. i.e. "output.txt"')
parser.add_argument('--lines', '-l', help='number of lines of output to print to the console"', type=int)

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

args = parser.parse_args()
domain = args.domain
ofile = args.ofile
lines = args.lines
print("domain:", domain)
print("output file:", ofile)
print("lines:", lines)

原文：https://medium.com/@ahadsheriff/the-best-way-to-make-command-line-interfaces-in-python-e00e8b9d10c9