之前寫(xiě)過(guò)一篇使用Wox+Python打造命令行工具庫(kù)，除了我們自定義命令行工具之外，Wox的強(qiáng)大之處，在于它的插件功能，可以安裝第三方插件以及自行設(shè)計(jì)編寫(xiě)插件。我們常用的程序搜索，網(wǎng)頁(yè)搜索，其實(shí)都是插件。

所以我們這一篇來(lái)聊聊如何編寫(xiě)Wox的插件

在進(jìn)入正題之前，先簡(jiǎn)單說(shuō)說(shuō)插件的安裝方式和運(yùn)行原理

安裝方式

Wox目前支持以下幾種安裝插件的方式。

使用wpm命令安裝官方倉(cāng)庫(kù)的插件

Wox內(nèi)置了wpm插件，專門(mén)用于管理插件。

安裝插件：wpm install <插件名字>

刪除插件: wpm uninstall <插件名字>

查看已安裝插件： wpm list

通過(guò)wox文件安裝

下載Wox插件包，以將插件安裝包下載到本地（以.wox結(jié)尾），然后將插件安裝包拖拽到Wox搜索框上即可開(kāi)始安裝。

通過(guò)源碼安裝

下載插件源碼，放到Wox的Plugins目錄下
C:\Users\Administrator\AppData\Local\Wox\app-1.3.524\Plugins

運(yùn)行原理

Wox與插件之間通過(guò)標(biāo)準(zhǔn)輸入輸出的方式通信，使用JSONRPC來(lái)完成通信。使用這種方式，將極大的提高Wox支持的插件種類， 幾乎任何語(yǔ)言都可以用來(lái)編寫(xiě)Wox插件。

編寫(xiě)插件

先來(lái)看看一個(gè)Hello World 插件，插件目錄

ico.ico 插件圖標(biāo)
plugin.json 文件包含了該插件的一些基本信息

{
    "ID":"2f4e384e-76ce-45c3-aea2-b16f5e5c328f",
    "ActionKeyword":"h",
    "Name":"Hello World",
    "Description":"Hello World",
    "Author":"jianbing",
    "Version":"1.0.0",
    "Language":"python",
    "Website":"https://github.com/jianbing",
    "IcoPath":"Images\\ico.ico",
    "ExecuteFileName":"main.py"
}

main.py 核心文件

# -*- coding: utf-8 -*-
from wox import Wox, WoxAPI
import pyperclip

class Main(Wox):

    def query(self, keyword):
        results = list()
        results.append({
            "Title": "input",
            "SubTitle": keyword,
            "IcoPath": "Images/ico.ico",
            "JsonRPCAction": {
                "method": "test_func",
                "parameters": [keyword],
                "dontHideAfterAction": False      # 運(yùn)行后是否隱藏Wox窗口
            }
        })
        return results

    def test_func(self, keyword):
        pyperclip.copy(keyword)

if __name__ == "__main__":
    Main()

運(yùn)行效果：

回車后，“hello”這個(gè)字符串就被復(fù)制到剪貼板中，可以到另外的文本區(qū)域進(jìn)行粘貼，看似非常完美

問(wèn)題來(lái)了，如果出現(xiàn)報(bào)錯(cuò)，比如導(dǎo)入的模塊名錯(cuò)了

import pyperclip1

Wox就默默呆住了

這樣沒(méi)有任何報(bào)錯(cuò)信息記錄，對(duì)于代碼編寫(xiě)和調(diào)試都是非常麻煩的

經(jīng)過(guò)一番嘗試，折騰出了Hello World Ex

看看新的目錄結(jié)構(gòu)，增加了一個(gè)util.py文件

util.py 封裝了捕獲報(bào)錯(cuò)所需的相關(guān)類庫(kù)和函數(shù)，以及簡(jiǎn)易的日志功能

# -*- coding: utf-8 -*-
from wox import Wox, WoxAPI
import types
import traceback
import logging
import functools
import os
from contextlib import contextmanager

logging.basicConfig(level=logging.DEBUG,
                    format='%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s',
                    datefmt='%a, %d %b %Y %H:%M:%S',
                    filename="error.log",
                    filemode='a')

class Log:
    @classmethod
    def debug(cls, msg):
        logging.debug(msg)

    @classmethod
    def info(cls, msg):
        logging.info(msg)

    @classmethod
    def error(cls, msg):
        logging.error(msg)

@contextmanager
def load_module():
    try:
        yield
    except:
        Log.error(traceback.format_exc())
        os.system(r'explorer "{}"'.format(os.getcwd()))

def _debug(func):
    @functools.wraps(func)
    def wrap(*args, **kwargs):
        try:
            return func(*args, **kwargs)
        except:
            error = traceback.format_exc()
            WoxAPI.show_msg("error", error)
            Log.error(error)
            os.system(r'explorer "{}"'.format(os.getcwd()))

    return wrap

class _DebugMeta(type):
    def __new__(cls, clsname, bases, attrs):
        for func_name, func in attrs.items():
            if isinstance(func, types.FunctionType):
                attrs[func_name] = _debug(func)
        return super(_DebugMeta, cls).__new__(cls, clsname, bases, attrs)

class WoxEx(Wox, metaclass=_DebugMeta):
    pass

main.py 做相應(yīng)的修改，其實(shí)修改并不多

# -*- coding: utf-8 -*-
# 固定寫(xiě)法，導(dǎo)入相關(guān)類庫(kù)和函數(shù)
from util import WoxEx, WoxAPI, load_module, Log

# 統(tǒng)一加載模塊
with load_module():
    import pyperclip

class Main(WoxEx):  # 繼承WoxEx
    def query(self, keyword):
        results = list()
        results.append({
            "Title": "input",
            "SubTitle": keyword,
            "IcoPath": "Images/ico.ico",
            "JsonRPCAction": {
                "method": "test_func",
                "parameters": [keyword],
                "dontHideAfterAction": False
            }
        })
        return results

    def test_func(self, keyword):
        pyperclip.copy(keyword)

if __name__ == "__main__":
    Main()

再來(lái)試試報(bào)錯(cuò)，還是剛剛的導(dǎo)入模塊名字錯(cuò)誤

with load_module():
    import pyperclip1

運(yùn)行的時(shí)候，會(huì)自動(dòng)彈出報(bào)錯(cuò)文件

打開(kāi)文件，可以看到完整的報(bào)錯(cuò)信息

Tue, 19 Feb 2019 17:33:16 util.py[line:29] ERROR Traceback (most recent call last):
  File "C:\Users\Administrator\AppData\Roaming\Wox\Plugins\Hello World Ex-991dfc7a-7c37-41f7-8e63-273f83c9680f\util.py", line 35, in load_module
    yield
  File "C:\Users\Administrator\AppData\Roaming\Wox\Plugins\Hello World Ex-991dfc7a-7c37-41f7-8e63-273f83c9680f\main.py", line 7, in <module>
    import pyperclip1
ModuleNotFoundError: No module named 'pyperclip1'

再來(lái)試試方法里邊的報(bào)錯(cuò)看看

def test_func(self, keyword):
    raise Exception("error!!!")
    pyperclip.copy(keyword)

回車后，彈出了報(bào)錯(cuò)文件所在目錄后，右下角也會(huì)彈窗顯示報(bào)錯(cuò)信息

大功告成~

插件的應(yīng)用

通過(guò)自定義插件，我們可以將一些操作集成上去，舉個(gè)栗子，物品道具的查找，不在需要打開(kāi)道具配置表進(jìn)行搜索了~

源碼下載

HelloWord和HelloWordEx的源碼已經(jīng)上傳到了GitHub，歡迎圍觀