使用Python cmd模块打造控制台应用

有时候我们需要自己开发一个控制台应用程序，以实现某些特定的功能。比如说开发一个命令行查询天气的工具，或是仅用于本地运行的代码调试工具，等等。在这种情况下，Python中的cmd模块就可以派上用场。

在本文中，我们将详细介绍如何使用Python的cmd模块来开发自己的控制台应用程序。我们会从多个方面对cmd模块做详细的阐述，希望本文能对各位读者在开发自己的控制台应用程序时提供帮助。

一、什么是Python cmd模块

Python的cmd模块是一个功能强大的库，它允许您创建交互式命令行程序。通过使用cmd模块，您可以创建自己的命令提示符，并根据用户输入调用各种命令来执行不同的功能。

使用cmd模块的好处在于，它允许您很容易地处理用户的输入并在需要时对其进行可靠和灵活的解析。您可以定义自己的命令行提示符以及各种命令，这些命令可以与您程序中的其他代码紧密集成，使得整个程序更加灵活。

二、创建基本的命令行应用程序

在Python中使用cmd模块创建基本的命令行应用程序非常容易。我们只需要继承cmd.Cmd类并定义我们自己的命令即可。下面是一个简单的示例程序：

import cmd

class MyApp(cmd.Cmd):
    prompt = 'myapp> '
    
    def do_hello(self, arg):
        print('Hello, ' + arg + '!')
        
    def do_quit(self, arg):
        return True
        
if __name__ == '__main__':
    app = MyApp()
    app.cmdloop()

在这个示例应用程序中，我们定义了一个MyApp类来继承cmd.Cmd类。我们把应用程序的提示符设置为’myapp> ‘，并定义了两个命令: hello和quit。

当用户在命令行中输入“hello”的时候，我们会调用do_hello()方法并打印出一个问候语。当用户在命令行中输入“quit”时，我们将返回True，表示我们要退出程序。我们使用if __name__ == ‘__main__’:来启动应用程序的主循环。

在运行时，我们会看到以下输出：

myapp> hello World
Hello, World!
myapp> quit

三、更多高级用例

1. 支持Tab自动完成

在很多命令行工具中，用户可以使用Tab键来自动补全他们正在输入的命令文本、选项和参数。在Python中，我们也可以很容易地添加Tab自动完成功能。

我们可以使用cmd模块的complete()方法来实现Tab自动完成。complete方法接受两个参数：一个字符串（包含用户输入的文本）和一个索引位置，该位置是用户正在输入的命令行中的光标位置。

import cmd

class MyApp(cmd.Cmd):
    prompt = 'myapp> '
    
    def do_hello(self, arg):
        print('Hello, ' + arg + '!')
        
    def do_quit(self, arg):
        return True
        
    def complete_hello(self, text, line, begidx, endidx):
        if not text:
            completions = ['world', 'python', 'cmd']
        else:
            completions = [f for f in ['world', 'python', 'cmd'] if f.startswith(text)]
        return completions
        
if __name__ == '__main__':
    app = MyApp()
    app.cmdloop()

在这个示例程序中，我们重写了complete_hello()方法，该方法在用户输入“hello”命令的时候自动调用。我们首先检查text参数是否为空，如果为空，我们将返回一个完整的补全列表（这里是 [‘world’, ‘python’, ‘cmd’]）。如果text不为空，则仅返回以text开头的项目列表。

在运行时，当用户输入“hello py”并按下Tab键时，我们会看到输出：

myapp> hello py
python  py

命令行自动完成功能可以大大简化用户的输入，提高应用程序的易用性。在创建自己的控制台应用程序时，建议您考虑添加此功能。

2. 使用参数选项

在某些情况下，您可能需要在命令行工具中支持选项和参数。例如，您打算使用一个命令行工具来处理某些文件，您可能需要指定输入和输出文件的名称、处理方式、格式等一些参数。

我们可以通过使用Python的argparse模块和cmd模块的parse()方法来轻松处理这些选项和参数。

import cmd
import argparse

class MyApp(cmd.Cmd):
    prompt = 'myapp> '

    def do_process(self, arg):
        parser = argparse.ArgumentParser(description='Process some integers.')
        parser.add_argument('filename', help='input file')
        parser.add_argument('--output', help='output file')
        parser.add_argument('--format', help='output format', choices=['txt', 'json', 'xml'])
        args = parser.parse_args(arg.split())
        print(f'Processing {args.filename}, output={args.output}, format={args.format}')

    def do_quit(self, arg):
        return True

if __name__ == '__main__':
    app = MyApp()
    app.cmdloop()

在这个示例程序中，我们定义了一个名为process的命令。我们使用argparse模块来解析process命令中的选项和参数。根据解析器的设置，我们需要一个名为 “filename” 的位置参数，”output” 和 “format” 两个可选参数。其中输出格式必须是[‘txt’, ‘json’, ‘xml’]之一。

在命令行中输入process test.txt –output result.txt –format json，输出会是：

myapp> process test.txt --output result.txt --format json
Processing test.txt, output=result.txt, format=json

四、小结

在本文中，我们介绍了Python中强大的命令行开发库cmd模块。与Python的其他库相比，cmd模块非常适合开发控制台应用程序。它为用户提供了又快又可靠的解决方案，使得开发者可以轻松地创建自己的命令行应用程序。在开发自己的控制台应用程序时，建议您使用和学习cmd模块以便实现一些高级应用程序的功能。

代码示例：

import cmd

class MyApp(cmd.Cmd):
    prompt = 'myapp> '
    
    def do_hello(self, arg):
        print('Hello, ' + arg + '!')
        
    def do_quit(self, arg):
        return True
        
    def complete_hello(self, text, line, begidx, endidx):
        if not text:
            completions = ['world', 'python', 'cmd']
        else:
            completions = [f for f in ['world', 'python', 'cmd'] if f.startswith(text)]
        return completions
        
if __name__ == '__main__':
    app = MyApp()
    app.cmdloop()