tenko-plugin-example 0.1.0__tar.gz → 0.2.0__tar.gz

{tenko_plugin_example-0.1.0 → tenko_plugin_example-0.2.0}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.5
 Name: tenko-plugin-example
-Version: 0.1.0
+Version: 0.2.0
 Summary: Tenko 第三方插件示例与模板
 Project-URL: Homepage, https://github.com/g1331/tenko/tree/main/examples/tenko-plugin-example
 Project-URL: Repository, https://github.com/g1331/tenko
 License-Expression: GPL-3.0-only
 Requires-Python: <3.14,>=3.11
 Requires-Dist: sqlalchemy>=2.0
-Requires-Dist: tenko-api<0.3,>=0.2
+Requires-Dist: tenko-api<0.4,>=0.3
 Description-Content-Type: text/markdown
 
 # tenko-plugin-example
@@ -33,7 +33,7 @@ Description-Content-Type: text/markdown
    的 `[project.urls]`（插件目录靠这里的 GitHub 地址确认仓库归你所有）。示例本身作为真实
    插件发布在 PyPI 上，这些地方写的是 Tenko 维护者的信息。
 4. **不要声明 `entari.plugin` 入口**：Entari 会无视 Tenko 的启用状态自动加载它。
-5. 依赖只写 `tenko-api` 的兼容范围（预览期为 `>=0.2,<0.3`）和插件自己的依赖，
+5. 依赖只写 `tenko-api` 的兼容范围（预览期为 `>=0.3,<0.4`）和插件自己的依赖，
    不要依赖 `tenko` 本体，也不要用 `==` 锁死依赖版本。
 
 ## 开发与测试
@@ -68,11 +68,16 @@ uv run ruff check .
 
 1. 在运行 Tenko 的环境里安装插件：`uv pip install tenko-plugin-xxx`（本地调试用
    `uv pip install -e /path/to/plugin`）。
-2. 打开 WebUI 的插件页，启用该插件（带“第三方”标记）。第三方插件默认关闭，启用后
-   写入 `.tenko/plugins/state.json`。
-3. 如有配置，在 `config/tenko.toml` 里添加 `[plugin_config.<插件 ID>]`，见仓库中
-   `config/tenko.toml.example` 末尾的说明。
-4. 重启 Tenko（聊天里的 `/重启` 或重新运行进程），插件才会被加载。
+2. 如有配置，在 `config/tenko.toml` 里添加 `[plugin_config.<插件 ID>]`，见仓库中
+   `config/tenko.toml.example` 末尾的说明。运行中的 Tenko 只认启动时读到的配置，改了配置
+   要重启。
+3. 打开 WebUI 的插件页，启用该插件（带“第三方”标记）。第三方插件默认关闭，启用后写入
+   `.tenko/plugins/state.json` 并直接加载。
+4. 本示例定义了数据库模型，运行中加载会被拒绝，面板会提示重启（聊天里的 `/重启` 或重新
+   运行进程）。没有数据库模型的插件不需要这一步。
+
+插件可能在 Tenko 运行中被加载，这时启动、就绪等生命周期事件已经过去，初始化不要只放在
+这些事件里。
 
 之后可以在 WebUI 开关页或用 `/开启`、`/关闭` 按群控制，插件命令与内置命令走同一套
 维护模式、功能开关和限流。

{tenko_plugin_example-0.1.0 → tenko_plugin_example-0.2.0}/README.md

@@ -21,7 +21,7 @@
    的 `[project.urls]`（插件目录靠这里的 GitHub 地址确认仓库归你所有）。示例本身作为真实
    插件发布在 PyPI 上，这些地方写的是 Tenko 维护者的信息。
 4. **不要声明 `entari.plugin` 入口**：Entari 会无视 Tenko 的启用状态自动加载它。
-5. 依赖只写 `tenko-api` 的兼容范围（预览期为 `>=0.2,<0.3`）和插件自己的依赖，
+5. 依赖只写 `tenko-api` 的兼容范围（预览期为 `>=0.3,<0.4`）和插件自己的依赖，
    不要依赖 `tenko` 本体，也不要用 `==` 锁死依赖版本。
 
 ## 开发与测试
@@ -56,11 +56,16 @@ uv run ruff check .
 
 1. 在运行 Tenko 的环境里安装插件：`uv pip install tenko-plugin-xxx`（本地调试用
    `uv pip install -e /path/to/plugin`）。
-2. 打开 WebUI 的插件页，启用该插件（带“第三方”标记）。第三方插件默认关闭，启用后
-   写入 `.tenko/plugins/state.json`。
-3. 如有配置，在 `config/tenko.toml` 里添加 `[plugin_config.<插件 ID>]`，见仓库中
-   `config/tenko.toml.example` 末尾的说明。
-4. 重启 Tenko（聊天里的 `/重启` 或重新运行进程），插件才会被加载。
+2. 如有配置，在 `config/tenko.toml` 里添加 `[plugin_config.<插件 ID>]`，见仓库中
+   `config/tenko.toml.example` 末尾的说明。运行中的 Tenko 只认启动时读到的配置，改了配置
+   要重启。
+3. 打开 WebUI 的插件页，启用该插件（带“第三方”标记）。第三方插件默认关闭，启用后写入
+   `.tenko/plugins/state.json` 并直接加载。
+4. 本示例定义了数据库模型，运行中加载会被拒绝，面板会提示重启（聊天里的 `/重启` 或重新
+   运行进程）。没有数据库模型的插件不需要这一步。
+
+插件可能在 Tenko 运行中被加载，这时启动、就绪等生命周期事件已经过去，初始化不要只放在
+这些事件里。
 
 之后可以在 WebUI 开关页或用 `/开启`、`/关闭` 按群控制，插件命令与内置命令走同一套
 维护模式、功能开关和限流。

{tenko_plugin_example-0.1.0 → tenko_plugin_example-0.2.0}/pyproject.toml

@@ -1,13 +1,13 @@
 [project]
 name = "tenko-plugin-example"
-version = "0.1.0"
+version = "0.2.0"
 description = "Tenko 第三方插件示例与模板"
 readme = "README.md"
 license = "GPL-3.0-only"
 requires-python = ">=3.11,<3.14"
 dependencies = [
     # 兼容声明：解析器据此拒绝不兼容的宿主。上限写到下一个次版本（1.0 之后写到主版本）。
-    "tenko-api>=0.2,<0.3",
+    "tenko-api>=0.3,<0.4",
     # 插件自己的依赖写在这里：只写下限，不要用 == 锁死，以免与宿主冲突。
     # Model 基于宿主已有的 SQLAlchemy，声明下限即可。
     "sqlalchemy>=2.0",

{tenko_plugin_example-0.1.0 → tenko_plugin_example-0.2.0}/src/tenko_plugin_example/__init__.py

@@ -12,7 +12,6 @@ from arclet.alconna import Alconna, Args, CommandMeta
 from arclet.entari import BasicConfModel, Session, command, plugin
 from arclet.entari.command import Query
 
-from tenko_api.context import context_from_session
 from tenko_api.features import declare
 from tenko_api.perm import Permission, require
 from tenko_api.storage import Model, Store, get_session
@@ -75,10 +74,10 @@ example_command = Alconna(
 @command.on(example_command)
 @require(Permission.User)
 async def example(session: Session, note: Query[str] = Query("note", "")):
-    ctx = context_from_session(session)
+    user_id = session.user.id
     # Store 是同步读写：读改写之间没有 await，协程不会交错，所以不需要加锁。
     records = visits.load(default={})
-    record = records.setdefault(ctx.user_id, {"count": 0})
+    record = records.setdefault(user_id, {"count": 0})
     record["count"] += 1
     visits.save(records)
 
@@ -86,12 +85,12 @@ async def example(session: Session, note: Query[str] = Query("note", "")):
     async with get_session() as db:
         previous = await db.scalar(
             select(Note.text)
-            .where(Note.user_id == ctx.user_id)
+            .where(Note.user_id == user_id)
             .order_by(Note.id.desc())
             .limit(1)
         )
         if note.result:
-            db.add(Note(user_id=ctx.user_id, text=note.result))
+            db.add(Note(user_id=user_id, text=note.result))
             await db.commit()
 
     reply = f"{config.greeting}，这是你第 {record['count']} 次使用示例命令"

{tenko_plugin_example-0.1.0 → tenko_plugin_example-0.2.0}/tests/conftest.py

@@ -6,15 +6,13 @@
 
 import json
 import os
-from datetime import datetime
 from types import SimpleNamespace
 
 import pytest
 import pytest_asyncio
 from arclet.entari import Entari
 from arclet.entari.config import EntariConfig
-from satori import Channel, ChannelType, EventType, Guild, Login, MessageObject, User
-from satori.model import Event, Member
+from satori import User
 
 from tenko.config import DatabaseConfig
 from tenko.db.bootstrap import load_database_plugin
@@ -65,17 +63,7 @@ def module(runtime):
     return runtime.loaded_plugins["example"].module
 
 
-def make_session(user_id: str, text: str = ""):
-    """构造 context_from_session 能解析的最小群聊 Session。"""
+def make_session(user_id: str):
+    """构造只带发送者的最小 Session，足够直接调用命令处理函数。"""
 
-    event = Event(
-        type=EventType.MESSAGE_CREATED,
-        timestamp=datetime.now(),
-        login=Login(platform="onebot", user=User("10001")),
-        channel=Channel("40001", ChannelType.TEXT),
-        guild=Guild("40001", "Tenko"),
-        member=Member(user=User(user_id)),
-        user=User(user_id),
-        message=MessageObject.from_elements("50001", []),
-    )
-    return SimpleNamespace(event=SimpleNamespace(_origin=event))
+    return SimpleNamespace(user=User(user_id))