使用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()