Alconna Avilla
包括解析器、Dispatcher、SayaSchema 和 附加组件
[!WARNING] 本项目与
avilla.core.builtins.command不兼容
安装
pip install arclet-alconna-avilla
pdm add arclet-alconna-avilla
快速使用
单文件
from arclet.alconna import Args, Alconna
from arclet.alconna.avilla import AlconnaDispatcher, Match, CommandResult
...
broadcast = create(Broadcast)
avilla = Avilla(...)
alc = Alconna("!jrrp", Args["sth", str, 1123])
@broadcast.receiver(
MessageReceived,
dispatchers=[AlconnaDispatcher(alc, send_flag='stay')]
)
async def test2(
context: Context,
result: CommandResult[MessageReceived],
sth: Match[str]
):
print("sign:", result.result)
print("sender:", context.scene)
print("match", sth.available, sth.result)
使用 Saya
in module.py:
from arclet.alconna.avilla import AlconnaDispatcher, Match, CommandResult, AlconnaSchema
from arclet.alconna import Alconna, Args
...
channel = Channel.current()
alc = Alconna("!jrrp", Args["sth", str, 1123])
@channel.use(AlconnaSchema(AlconnaDispatcher(alc)))
@channel.use(ListenerSchema([...]))
async def test2(result: CommandResult[...], sth: Match[str]):
print("sign:", result.result)
print("match", sth.available, sth.result)
in main.py:
from arclet.alconna.avilla 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.saya.builtins.broadcast.shortcut import listen
from arclet.alconna.avilla import alcommand, Match, from_command, startswith, endswith
from arclet.alconna import Args, Arparma, Alconna
...
@alcommand(Alconna("!jrrp", Args["sth", str, 1123]), private=False)
async def test1(result: Arparma, sth: Match[str]):
print("sign:", result)
print("match", sth.available, sth.result)
@alcommand("[!|.]hello <name:str>", send_error=True)
async def test1(result: Arparma, name: Match[str]):
print("sign:", result)
print("match", name.available, name.result)
@listen(...)
@from_command("foo bar {baz}")
async def test2(baz: int):
print("baz", baz)
@listen(...)
@startswith("foo bar")
async def test3(event: ...):
...
@listen(...)
@endswith(int)
async def test4(event: ...):
...
in main.py:
from creart import create
...
saya = create(Saya)
with saya.module_context():
saya.require("module")
AlconnaDispatcher 参数说明
class AlconnaDispatcher(BaseDispatcher, Generic[TOHandler]):
def __init__(
self,
command: Alconna | AlconnaGroup,
*,
send_flag: Literal["reply", "post", "stay"] = "stay",
skip_for_unmatch: bool = True,
comp_session: Optional[CompConfig] = None,
message_converter: Callable[[OutType, str], MessageChain | Coroutine[Any, Any, MessageChain]] | None = None,
): ...
command: 使用的 Alconna 指令
send_flag: 解析期间输出信息的发送方式
- reply: 直接发送给指令发送者
- post: 以事件通过 Broadcast 广播
- stay: 存入 CommandResult 传递给事件处理器
skip_for_unmatch: 解析失败时是否跳过, 否则错误信息按 send_flag 处理
comp_session: 补全会话配置, 不传入则不启用补全会话
message_converter: send_flag 为 reply 时 输出信息的预处理器
附加组件
-
Match: 查询某个参数是否匹配，如foo: Match[int]。使用时以Match.available判断是否匹配成功，以Match.result获取匹配结果 -
Query: 查询某个参数路径是否存在，如sth: Query[int] = Query("foo.bar")；可以指定默认值如Query("foo.bar", 1234)。使用时以Query.available判断是否匹配成功，以Query.result获取匹配结果 -
Header: 表示命令头部为特殊形式时的头部匹配 -
assign: 依托路径是否匹配成功为命令分发处理器。
from arclet.alconna.avilla import assign, alcommand
from arclet.alconna import Alconna, Arpamar
...
alc = Alconna(...)
@alcommand(alc, private=False)
@assign("foo")
async def foo(result: Arpamar):
...
@alcommand(alc, private=False)
@assign("bar.baz", 1)
async def bar_baz_1(result: Arpamar):
...
便捷方法
from arclet.alconna.avilla import Match, Alc
...
@app.broadcast.receiver(
..., dispatchers=[Alc.from_format("foo bar {baz:int}")]
)
async def test2(baz: Match[int]):
print("match", baz.available, baz.result)
or
from arclet.alconna.avilla import Match, AlconnaSchema
...
channel = Channel.current()
@channel.use(AlconnaSchema.from_("foo {sth:str} bar {baz:int}"))
@channel.use(ListenerSchema([...]))
async def test2(sth: Match[str]):
print("match", sth.available, sth.result)
文档
Metadata
Release files for arclet-alconna-avilla 0.19.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| arclet_alconna_avilla-0.19.4.tar.gz | 18.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| arclet_alconna_avilla-0.19.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 40.5 kB
Release files / arclet_alconna_avilla-0.19.4.tar.gz
| Download URL | arclet_alconna_avilla-0.19.4.tar.gz |
|---|---|
| Size | 18.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0a9bf51c3134be647863a4a9dad7bf9f6a4ddd9e8f02d11ce9ff8fac17de1997
|
|
BLAKE2b-256 checksum How to use checksums |
32b0e80f3720ada0f98714991241cd0b42441dcbdce8d100b7cab8737a0666f9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
pdm/2.19.1 CPython/3.9.13 Windows/10
|
Release files / arclet_alconna_avilla-0.19.4-py3-none-any.whl
| Download URL | arclet_alconna_avilla-0.19.4-py3-none-any.whl |
|---|---|
| Size | 22.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
96b19c3a371cdae636a9fe4ba309003fceea068842b94f797ffa454c2a0cc5bd
|
|
BLAKE2b-256 checksum How to use checksums |
b36141781d5aaab90fedc008231d13de5b849d1e8de11f523db25d4845f44247
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
pdm/2.19.1 CPython/3.9.13 Windows/10
|
