四個(gè)Python庫(kù)，實(shí)現(xiàn)超實(shí)用的命令行功能

作者：佚名 2017-07-10 14:00:04

這是我的二部曲終端應(yīng)用程序與偉大的命令行界面的第二部分。在第一篇文章中，我介紹了幾個(gè)能使使用命令行程序充滿樂(lè)趣的功能。在第二部分中，我將介紹如何在幾個(gè) Python 庫(kù)的幫助下實(shí)現(xiàn)這些功能。

在二部曲系列文章的第二部分關(guān)于偉大的命令行 UI 終端應(yīng)用文章中，我們探索了“提示工具包”，“命令行界面創(chuàng)建工具包“，“Pygments”和“模糊搜索”。

這是我的二部曲終端應(yīng)用程序與偉大的命令行界面的第二部分。在第一篇文章中，我介紹了幾個(gè)能使使用命令行程序充滿樂(lè)趣的功能。在第二部分中，我將介紹如何在幾個(gè) Python 庫(kù)的幫助下實(shí)現(xiàn)這些功能。在本文結(jié)尾，讀者應(yīng)該很好地了解如何使用 Prompt Toolkit，Click(命令行界面創(chuàng)建工具包)，Pygments 和 Fuzzy Finder 來(lái)實(shí)現(xiàn)一個(gè)易于使用的 REPL(交互式解釋器)。

我計(jì)劃用少于 20 行的 Python 代碼中實(shí)現(xiàn)這一點(diǎn)。讓我們開(kāi)始。

Python 提示工具包

我喜歡將這個(gè)庫(kù)看作是像瑞士軍刀那樣集大成者的命令行應(yīng)用程序，它可以替代 readline，curses 等等。讓我們來(lái)安裝這個(gè)庫(kù)并開(kāi)始使用：

pip install prompt_toolkit

我們將從簡(jiǎn)單的 REPL 開(kāi)始。通常 REPL 將接受用戶輸入，執(zhí)行操作并打印結(jié)果。對(duì)于我們的例子，我們要構(gòu)建一個(gè)“echo”REPL。它只是打印出用戶輸入的內(nèi)容：

交互式解釋器

from prompt_toolkit import prompt 
 
while 1: 
 
  user_input = prompt('>') 
 
  print(user_input)

這就是實(shí)現(xiàn) REPL 所需要的。它可以讀取用戶輸入并打印輸入的內(nèi)容。此代碼段中使用的提示函數(shù)來(lái)自 prompt_toolkit 庫(kù);它是 readline 庫(kù)的替代者。

歷史記錄

為了增強(qiáng)我們的REPL，我們可以添加歷史命令：

from prompt_toolkit import prompt 
 
from prompt_toolkit.history import FileHistory 
 
while 1: 
 
    user_input = prompt('>', 
 
                        history=FileHistory('history.txt'), 
 
                       ) 
 
    print(user_input)

我們剛剛向REPL添加了持久的歷史記錄。現(xiàn)在我們可以使用向上/向下箭頭瀏覽歷史記錄，并使用 Ctrl + R 搜索歷史。這符合命令行的基本習(xí)慣。

自動(dòng)提示

我在第一部分中介紹的技巧之一是自動(dòng)提示歷史命令。(我們看到這個(gè)功能最先在 Fish shell中推出。)讓我們把這個(gè)功能添加到我們的REPL中：

from prompt_toolkit import prompt 
 
from prompt_toolkit.history import FileHistory 
 
from prompt_toolkit.auto_suggest import AutoSuggestFromHistory 
 
while 1: 
 
    user_input = prompt('>', 
 
                        history=FileHistory('history.txt'), 
 
                        auto_suggest=AutoSuggestFromHistory(), 
 
                       ) 
 
    print(user_input)

我們只需要在 prompt() API 調(diào)用中添加一個(gè)新的參數(shù)。現(xiàn)在我們的 REPL 已經(jīng)可以支持類似 Fish Shell 那樣的歷史命令自動(dòng)提示功能了。

自動(dòng)補(bǔ)全

現(xiàn)在我們通過(guò) Tab 增強(qiáng)來(lái)實(shí)現(xiàn)自動(dòng)補(bǔ)全，當(dāng)用戶開(kāi)始鍵入輸入時(shí)，它彈出可能的建議。

我們的 REPL 是如何知道要給出什么提示的? 我們提供了一個(gè)可能名目提示的字典。

假設(shè)我們正在為 SQL 實(shí)現(xiàn) REPL。我們可以使用 SQL 關(guān)鍵字存儲(chǔ)我們的自動(dòng)完成字典。讓我們看看如何做到這一點(diǎn)：

from prompt_toolkit import prompt 
 
from prompt_toolkit.history import FileHistory 
 
from prompt_toolkit.auto_suggest import AutoSuggestFromHistory 
 
from prompt_toolkit.contrib.completers import WordCompleter 
 
SQLCompleter = WordCompleter(['select', 'from', 'insert', 'update', 'delete', 'drop'], 
 
                             ignore_case=True) 
 
while 1: 
 
    user_input = prompt('SQL>', 
 
                        history=FileHistory('history.txt'), 
 
                        auto_suggest=AutoSuggestFromHistory(), 
 
                        completer=SQLCompleter, 
 
                        ) 
 
    print(user_input)

再次，我們只需使用一個(gè)名為 WordCompleter 的 prompt-toolkit 的內(nèi)置例程，它將用戶輸入與可能提示的字典進(jìn)行匹配，并提供一個(gè)列表。

我們現(xiàn)在有一個(gè) REPL，它可以自動(dòng)補(bǔ)全，fish 式的歷史提示，以及歷史命令的上下瀏覽。所有這些都在不到 10 行的實(shí)際代碼中。

命令行界面創(chuàng)建工具包

Click 是一個(gè)命令行創(chuàng)建工具包，可以方便地解析程序的命令行選項(xiàng)參數(shù)和參數(shù)。本節(jié)不介紹如何作為參數(shù)解析器使用Click;取而代之的是我將研究一些 Click 庫(kù)的其他功能的。

安裝 click 很簡(jiǎn)單

pip install click

分頁(yè)器

分頁(yè)器是在 Unix 上用來(lái)一次性長(zhǎng)輸出顯示的實(shí)用程序。分頁(yè)器包括一些 less， more， most等。通過(guò)分頁(yè)器顯示命令不僅僅是友好的設(shè)計(jì)，而且也是需要的。

讓我們進(jìn)一步來(lái)看以上的例子。我們可以用 click.echo_via_pager() 來(lái)代替默認(rèn)的 print() 語(yǔ)句。這將通過(guò)分頁(yè)器將輸出傳遞給 stdout，這和平臺(tái)無(wú)關(guān)，因此可以在 Windows 或者 Unix 上運(yùn)行。click.echo_via_pager() 將嘗試用默認(rèn)的分頁(yè)器來(lái)輸出，以便在需要的時(shí)候顯示有顏色的代碼：

from prompt_toolkit import prompt 
 
from prompt_toolkit.history import FileHistory 
 
from prompt_toolkit.auto_suggest import AutoSuggestFromHistory 
 
from prompt_toolkit.contrib.completers import WordCompleter 
 
import click 
 
SQLCompleter = WordCompleter(['select', 'from', 'insert', 'update', 'delete', 'drop'], 
 
                             ignore_case=True) 
 
while 1: 
 
    user_input = prompt(u'SQL>', 
 
                        history=FileHistory('history.txt'), 
 
                        auto_suggest=AutoSuggestFromHistory(), 
 
                        completer=SQLCompleter, 
 
                        ) 
 
    click.echo_via_pager(user_input)

編輯器

在我之前的文章中提到一個(gè)細(xì)節(jié)，就是當(dāng)命令變得太復(fù)雜時(shí)就會(huì)回到編輯器，同樣的 click 提供了一個(gè)簡(jiǎn)單的 API 可以來(lái)啟動(dòng)編輯器，并將編輯器中輸入的文本返回到應(yīng)用中：

import click 
 
message = click.edit()

模糊搜索

模糊搜索是一種讓用戶通過(guò)最少的輸入來(lái)縮小提示。同樣有一個(gè)模糊搜索庫(kù)，讓我們安裝這個(gè)庫(kù)：

pip install fuzzyfinder

模糊搜索的API很簡(jiǎn)單，你傳遞進(jìn)部分字符串和一個(gè)可能選擇的列表，模糊搜索將返回一個(gè)新的列表，它和使用了按相關(guān)性排序的迷糊算法的字符串進(jìn)行匹配，例如：

>>> from fuzzyfinder import fuzzyfinder 
 
>>> suggestions = fuzzyfinder('abc', ['abcd', 'defabca', 'aagbec', 'xyz', 'qux']) 
 
>>> list(suggestions) 
 
['abcd', 'defabca', 'aagbec']

現(xiàn)在我們有了模糊搜索，我們將它加入到我們的 SQL 交互式解釋器中。這樣就定義了一個(gè)完成器，而不是 prompt-toolkit 附帶的 WordCompleter。例如：

from prompt_toolkit import prompt 
 
from prompt_toolkit.history import FileHistory 
 
from prompt_toolkit.auto_suggest import AutoSuggestFromHistory 
 
from prompt_toolkit.completion import Completer, Completion 
 
import click 
 
from fuzzyfinder import fuzzyfinder 
 
SQLKeywords = ['select', 'from', 'insert', 'update', 'delete', 'drop'] 
 
class SQLCompleter(Completer): 
 
    def get_completions(self, document, complete_event): 
 
        word_before_cursor = document.get_word_before_cursor(WORD=True) 
 
        matches = fuzzyfinder(word_before_cursor, SQLKeywords) 
 
        for m in matches: 
 
            yield Completion(m, start_position=-len(word_before_cursor)) 
 
while 1: 
 
    user_input = prompt(u'SQL>', 
 
                        history=FileHistory('history.txt'), 
 
                        auto_suggest=AutoSuggestFromHistory(), 
 
                        completer=SQLCompleter(), 
 
                        ) 
 
    click.echo_via_pager(user_input)

Pygments

現(xiàn)在我們來(lái)給用戶輸入添加語(yǔ)法高亮顯示。我們正在構(gòu)建 SQL 交互式解釋器，并且擁有彩色的 SQL 語(yǔ)句會(huì)很好。

Pygments 是一個(gè)語(yǔ)法高亮庫(kù)，內(nèi)置支持300多種語(yǔ)言。添加語(yǔ)法高亮使得應(yīng)用程序變成彩色的，可以幫助用戶在執(zhí)行 SQL 之前發(fā)現(xiàn)一些例如打字錯(cuò)誤或者無(wú)法匹配的引號(hào)和括號(hào)。

首先安裝 Pygments

pip install pygments

讓我們用 pygments 給我們的 SQL 交互式解釋器添加顏色：

from prompt_toolkit import prompt 
 
from prompt_toolkit.history import FileHistory 
 
from prompt_toolkit.auto_suggest import AutoSuggestFromHistory 
 
from prompt_toolkit.completion import Completer, Completion 
 
import click 
 
from fuzzyfinder import fuzzyfinder 
 
from pygments.lexers.sql import SqlLexer 
 
SQLKeywords = ['select', 'from', 'insert', 'update', 'delete', 'drop'] 
 
class SQLCompleter(Completer): 
 
    def get_completions(self, document, complete_event): 
 
        word_before_cursor = document.get_word_before_cursor(WORD=True) 
 
        matches = fuzzyfinder(word_before_cursor, SQLKeywords) 
 
        for m in matches: 
 
            yield Completion(m, start_position=-len(word_before_cursor)) 
 
while 1: 
 
    user_input = prompt(u'SQL>', 
 
                        history=FileHistory('history.txt'), 
 
                        auto_suggest=AutoSuggestFromHistory(), 
 
                        completer=SQLCompleter(), 
 
                        lexer=SqlLexer, 
 
                        ) 
 
    click.echo_via_pager(user_input)

提示工具包適用于 Pygments 庫(kù)。我們選擇 Pygments 提供的 SqlLexer 并將其從提示工具包傳遞給 API 。現(xiàn)在所有的用戶輸入都會(huì)被當(dāng)作 SQL 語(yǔ)句并且添上了顏色。

結(jié)論

我們本次成果的結(jié)論是通過(guò)創(chuàng)建一個(gè)強(qiáng)大的交互式解釋器，擁有常見(jiàn) shell 的所有功能，例如歷史記錄，鍵綁定，和很友好的自動(dòng)完成，模糊搜索，分頁(yè)器，編輯器和語(yǔ)法高亮的功能。我們用少于 20 個(gè) python 語(yǔ)句實(shí)現(xiàn)了所有這些。

不是很容易嗎?現(xiàn)在你還有什么理由寫不出一個(gè)優(yōu)秀的命令行應(yīng)用程序呢，這里有一些可能有幫助的資源：