歡迎光臨
每天分享高質量文章

你還在手寫命令列功能?看這四個Python庫如何自動實現

使用命令列程式有很多充滿樂趣的功能,例如“提示工具包”,“命令列界面創建工具包“,“Pygments”和“模糊搜索”,我將介紹如何在幾個 Python 庫的幫助下實現這些功能。

 在本文結尾,讀者應該很好地瞭解如何使用 Prompt Toolkit,Click(命令列界面創建工具包),Pygments 和 Fuzzy Finder 來實現一個易於使用的 REPL(交互式解釋器)。

我計劃用少於 20 行的 Python 代碼中實現這一點。

讓我們開始,GO!

Python 提示工具包

我喜歡將這個庫看作是像瑞士軍刀那樣集大成者的命令列應用程式,它可以替代 readline,curses 等等。 讓我們來安裝這個庫並開始使用:

pip install prompt_toolkit

我們將從簡單的 REPL 開始。 通常 REPL 將接受用戶輸入,執行操作並打印結果。 對於我們的例子,我們要構建一個“echo”REPL。 它只是打印出用戶輸入的內容:

交互式解釋器

from prompt_toolkit import prompt

while 1:

    user_input = prompt(‘>’)

    print(user_input)

這就是實現 REPL 所需要的。它可以讀取用戶輸入並打印輸入的內容。此代碼段中使用的提示函式來自 prompt_toolkit 庫;它是 readline 庫的替代者。

歷史記錄

為了增強我們的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添加了持久的歷史記錄。現在我們可以使用向上/向下箭頭瀏覽歷史記錄,並使用 Ctrl + R 搜索歷史。這符合命令列的基本習慣。

自動提示

我在第一部分中介紹的技巧之一是自動提示歷史命令。(我們看到這個功能最先在 Fish shell中推出。)讓我們把這個功能添加到我們的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 呼叫中添加一個新的引數。現在我們的 REPL 已經可以支持類似 Fish Shell 那樣的歷史命令自動提示功能了。

自動補全

現在我們通過 Tab 增強來實現自動補全,當用戶開始鍵入輸入時,它彈出可能的建議。

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

假設我們正在為 SQL 實現 REPL。我們可以使用 SQL 關鍵字儲存我們的自動完成字典。讓我們看看如何做到這一點:

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)

再次,我們只需使用一個名為 WordCompleter 的 prompt-toolkit 的內置例程,它將用戶輸入與可能提示的字典進行匹配,並提供一個串列。

我們現在有一個 REPL,它可以自動補全,fish 式的歷史提示,以及歷史命令的上下瀏覽。 所有這些都在不到 10 行的實際代碼中。

命令列界面創建工具包

Click 是一個命令列創建工具包,可以方便地解析程式的命令列選項引數和引數。 本節不介紹如何作為引數解析器使用Click;取而代之的是我將研究一些 Click 庫的其他功能的。

安裝 click 很簡單

pip install click

分頁器

分頁器是在 Unix 上用來一次性長輸出顯示的實用程式。分頁器包括一些 less, more, most等。通過分頁器顯示命令不僅僅是友好的設計,而且也是需要的。

讓我們進一步來看以上的例子。我們可以用 click.echo_via_pager() 來代替預設的 print() 陳述句。這將通過分頁器將輸出傳遞給 stdout,這和平臺無關,因此可以在 Windows 或者 Unix 上運行。click.echo_via_pager() 將嘗試用預設的分頁器來輸出,以便在需要的時候顯示有顏色的代碼:

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)

編輯器

在我之前的文章中提到一個細節,就是當命令變得太複雜時就會回到編輯器,同樣的 click 提供了一個簡單的 API 可以來啟動編輯器,並將編輯器中輸入的文本傳回到應用中:

import click

message = click.edit()

模糊搜索

模糊搜索是一種讓用戶通過最少的輸入來縮小提示。同樣有一個模糊搜索庫,讓我們安裝這個庫:

pip install fuzzyfinder

模糊搜索的API很簡單,你傳遞進部分字串和一個可能選擇的串列,模糊搜索將傳回一個新的串列,它和使用了按相關性排序的迷糊演算法的字串進行匹配,例如:

>>> from fuzzyfinder import fuzzyfinder

>>> suggestions = fuzzyfinder(‘abc’, [‘abcd’, ‘defabca’, ‘aagbec’, ‘xyz’, ‘qux’])

>>> list(suggestions)

[‘abcd’, ‘defabca’, ‘aagbec’]

現在我們有了模糊搜索,我們將它加入到我們的 SQL 交互式解釋器中。這樣就定義了一個完成器,而不是 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

現在我們來給用戶輸入添加語法高亮顯示。我們正在構建 SQL 交互式解釋器,並且擁有彩色的 SQL 陳述句會很好。

Pygments 是一個語法高亮庫,內置支持300多種語言。添加語法高亮使得應用程式變成彩色的,可以幫助用戶在執行 SQL 之前發現一些例如打字錯誤或者無法匹配的引號和括號。

首先安裝 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 庫。我們選擇 Pygments 提供的 SqlLexer 並將其從提示工具包傳遞給 API 。現在所有的用戶輸入都會被當作 SQL 陳述句並且添上了顏色。

結論

我們本次成果的結論是通過創建一個強大的交互式解釋器,擁有常見 shell 的所有功能,例如歷史記錄,鍵系結,和很友好的自動完成,模糊搜索,分頁器,編輯器和語法高亮的功能。我們用少於 20 個 python 陳述句實現了所有這些。

不是很容易嗎?現在你還有什麼理由寫不出一個優秀的命令列應用程式呢,這裡有一些可能有幫助的資源:

  • Click (命令列界面創建工具包)
  • 模糊搜索
  • 提示工具包
  • 請參閱 Prompt Toolkit 教程和 prompt-toolkit 中的例子
  • Pygments

2017年5月20日,Amjith Ramanujam在俄勒岡州波特蘭市舉辦的美國 2017 PyCon 大會上做了名為《超棒的命令列工具》的演講,你可以通過這個演講瞭解更多內容。

編譯作者: fighteryu

原文鏈接:http://python.jobbole.com/87830/

赞(0)

分享創造快樂