arclet-alconna-graia 0.7.0

Support Alconna to GraiaProject

Alconna Graia

该项目为 Alconna 为 GraiaProject 下项目的内建支持

包括解析器、Dispatcher、SayaSchema 和 附加组件

快速使用

单文件

from arclet.alconna.graia import AlconnaDispatcher, Match, AlconnaProperty
from arclet.alconna import Alconna, Args
...

app = Ariadne(...)


alc = Alconna("!jrrp", Args["sth", str, 1123])

@app.broadcast.receiver(
    GroupMessage,
    dispatchers=[AlconnaDispatcher(alc, send_flag='stay')]
)
async def test2(
        group: Group,
        result: AlconnaProperty[GroupMessage],
        sth: Match[str]
):
    print("sign:", result.result)
    print("sender:", group)
    print("match", sth.available, sth.result)

使用 Saya

in module.py:

from arclet.alconna.graia import Alc, Match, AlconnaProperty, AlconnaSchema
from arclet.alconna import Alconna, Args
...
channel = Channel.current()

alc = Alconna("!jrrp", Args["sth", str, 1123])

@channel.use(AlconnaSchema(Alc(alc)))
@channel.use(ListenerSchema([GroupMessage]))
async def test2(group: Group, result: AlconnaProperty[GroupMessage], sth: Match[str]):
    print("sign:", result.result)
    print("sender:", group)
    print("match", sth.available, sth.result)

in main.py:

from arclet.alconna.graia import AlconnaBehaviour
from creart import create
...

saya = create(Saya)
create(AlconnaBehaviour)

with saya.module_context():
    saya.require("module")

使用 Saya Util

in module.py:

from graia.ariadne.util.saya import listen
from arclet.alconna.graia import Match, alcommand, from_command, startswith, endswith
from arclet.alconna import Alconna, Args, Arpamar

...


@alcommand(Alconna("!jrrp", Args["sth", str, 1123]), private=False)
async def test1(group: Group, result: Arpamar, sth: Match[str]):
    print("sign:", result)
    print("sender:", group)
    print("match", sth.available, sth.result)


@alcommand("[!|.]hello <name:str>;say <word>", send_error=True)
async def test1(group: Group, result: Arpamar, name: Match[str]):
    print("sign:", result)
    print("sender:", group)
    print("match", name.available, name.result)
    
    
@from_command("foo bar {baz}")
@listen(GroupMessage)
async def test2(baz: int):
    print("baz", baz)

@startswith("foo bar")
@listen(GroupMessage)
async def test3(event: GroupMessage):
    ...

@endswith(int)
@listen(GroupMessage)
async def test4(event: GroupMessage):
    ...

in main.py:

from creart import create
...

saya = create(Saya)

with saya.module_context():
    saya.require("module")

AlconnaDispatcher 参数说明

class AlconnaDispatcher(BaseDispatcher):
    def __init__(
        self,
        command: Union[Alconna, AlconnaGroup],
        *,
        send_flag: Literal["reply", "post", "stay"] = "stay",
        skip_for_unmatch: bool = True,
        send_handler: Optional[Callable[[str], MessageChain]] = None,
        allow_quote: bool = False
    ): ...

command: 使用的 Alconna 指令

send_flag: 解析期间输出信息的发送方式

• reply: 直接发送给指令发送者
• post: 以事件通过 Broadcast 广播
• stay: 存入 AlconnaProperty 传递给事件处理器

skip_for_unmatch: 解析失败时是否跳过, 否则错误信息按 send_flag 处理

send_handler: send_flag 为 reply 时 输出信息的预处理器

allow_quote: 是否允许以回复的方式触发指令

附加组件

• Match: 查询某个参数是否匹配，如foo: Match[int]。使用时以 Match.available 判断是否匹配成功，以 Match.result 获取匹配结果

• Query: 查询某个参数路径是否存在，如sth: Query[int] = Query("foo.bar")；可以指定默认值如 Query("foo.bar", 1234)。使用时以 Query.available 判断是否匹配成功，以 Query.result 获取匹配结果

• assign: 依托路径是否匹配成功为命令分发处理器。

from arclet.alconna.graia import alcommand, assign
from arclet.alconna import Alconna, Args, Arpamar
...

alc = Alconna(...)

@alcommand(alc, private=False)
@assign("foo")
async def foo(group: Group, result: Arpamar):
    ...

@alcommand(alc, private=False)
@assign("bar.baz", 1)
async def bar_baz_1(group: Group, result: Arpamar):
    ...

便捷方法

from arclet.alconna.graia import Alc, Match
...

app = Ariadne(...)

@app.broadcast.receiver(
    GroupMessage, dispatchers=[Alc.from_format("foo bar {baz:int}")]
)
async def test2(group: Group, baz: Match[int]):
    print("sender:", group)
    print("match", baz.available, baz.result)

or

from arclet.alconna.graia import Match, AlconnaSchema
...
channel = Channel.current()

@channel.use(AlconnaSchema.from_("foo <arg:str>", "bar"))
@channel.use(ListenerSchema([GroupMessage]))
async def test2(group: Group, sth: Match[str]):
    print("sender:", group)
    print("match", sth.available, sth.result)

文档

链接