Jarvis智能助手插件开发指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_01123/article/details/148602456

Jarvis智能助手插件开发指南

Jarvis Personal Assistant for Linux and macOS 项目地址: https://gitcode.com/gh_mirrors/jar/Jarvis

前言

Jarvis是一款功能强大的智能助手工具，其核心功能通过插件系统实现。本文将详细介绍如何为Jarvis开发自定义插件，涵盖从基础到高级的各项功能。

插件基础开发

函数式插件

最简单的插件实现方式是使用函数式编程：

from plugin import plugin

@plugin("hello world")
def hello_world(jarvis, s):
    """打印"hello world!"欢迎信息"""
    jarvis.say("Hello World!")

类式插件

对于更复杂的插件，可以使用类实现：

from plugin import plugin

@plugin("hello world")
class hello_world:
    """打印"hello world!"欢迎信息"""
    def __call__(self, jarvis, s):
        jarvis.say("Hello World!")

插件参数解析

每个插件都会接收两个核心参数：

jarvis：JarvisAPI实例，提供与助手交互的各种方法
s：字符串类型，用户输入的完整命令

插件存放位置

Jarvis会从两个位置查找插件：

custom目录：存放开发者自定义插件
jarviscli/plugins目录：存放系统预装插件

建议开发阶段将插件放在custom目录，完成后再移至正式插件目录。

高级插件功能

别名功能(@alias)

通过@alias装饰器可以为插件创建多个调用名称：

from plugin import plugin, alias

@alias("Hello", "Hi")
@plugin("helloworld")
def helloWorld(jarvis, s):
    jarvis.say("欢迎使用Jarvis!")

这样既可以通过"helloworld"调用，也可以通过"Hello"或"Hi"调用。

系统要求(@require)

使用@require装饰器可以指定插件的运行环境要求：

from plugin import plugin, require, PYTHON3, LINUX, WINDOWS

@require(platform=[LINUX, WINDOWS], 
         python=PYTHON3, 
         network=True,
         native=["firefox", "curl"])
@plugin("net_tool")
def network_tool(jarvis, s):
    """需要Python3、Linux/Windows系统、网络连接和firefox/curl的工具"""

支持的要求类型包括：

平台：LINUX, MACOS, WINDOWS, UNIX
Python版本：PYTHON2, PYTHON3
网络连接：True/False
本地程序：指定必须存在的可执行文件

自动补全(@complete)

实现命令自动补全功能：

from plugin import plugin, complete

@complete("option1", "option2")
@plugin("complex_cmd")
def complex_command(jarvis, s):
    """支持option1和option2参数补全"""

多词命令处理

对于"check ram"和"check weather"这类多词命令，建议拆分为独立插件：

@plugin("check weather")
def check_weather(jarvis, s):
    """查询天气"""
    ...

@alias("info ram")
@plugin("check ram")
def check_ram(jarvis, s):
    """查看内存使用"""
    ...

类插件的生命周期方法

类插件可以定义更多控制方法：

from plugin import plugin

@plugin
class AdvancedPlugin:
    """高级插件示例"""
    
    def init(self, jarvis):
        """初始化时调用"""
        jarvis.say("插件初始化完成!")
    
    def require(self):
        """返回运行要求"""
        return {"python": PYTHON3}
    
    def complete(self):
        """返回补全选项"""
        return ["option1", "option2"]
    
    def alias(self):
        """返回别名列表"""
        return ["shortcut"]
    
    def run(self, jarvis, s):
        """主执行方法"""
        jarvis.say("主功能执行!")