Skip to content

Commit 328952f

Browse files
committed
fix(docs): update decorator import paths from plugin.sdk.decorators to plugin.sdk.plugin
- Changed all instances in documentation to reflect the new import path for decorators. - Updated examples and references in Japanese and Chinese documentation to ensure consistency with the SDK structure.
1 parent 5848283 commit 328952f

158 files changed

Lines changed: 1411 additions & 33014 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/ja/plugins/decorators.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# デコレーター
22

3-
すべてのデコレーターは `plugin.sdk.decorators` からインポートします。
3+
すべてのデコレーターは `plugin.sdk.plugin` からインポートします。
44

55
## @neko_plugin
66

77
クラスを N.E.K.O. プラグインとしてマークします。すべてのプラグインクラスに必須です。
88

99
```python
10-
from plugin.sdk.decorators import neko_plugin
10+
from plugin.sdk.plugin import neko_plugin
1111

1212
@neko_plugin
1313
class MyPlugin(NekoPluginBase):
@@ -19,7 +19,7 @@ class MyPlugin(NekoPluginBase):
1919
外部から呼び出し可能なエントリーポイントを定義します。
2020

2121
```python
22-
from plugin.sdk.decorators import plugin_entry
22+
from plugin.sdk.plugin import plugin_entry
2323

2424
@plugin_entry(
2525
id="process", # エントリーポイント ID(必須)
@@ -55,7 +55,7 @@ def process(self, data: str, **_):
5555
ライフサイクルイベントハンドラーを定義します。
5656

5757
```python
58-
from plugin.sdk.decorators import lifecycle
58+
from plugin.sdk.plugin import lifecycle
5959

6060
@lifecycle(id="startup")
6161
def on_startup(self, **_):
@@ -80,7 +80,7 @@ def on_reload(self, **_):
8080
固定間隔で実行されるスケジュールタスクを定義します。
8181

8282
```python
83-
from plugin.sdk.decorators import timer_interval
83+
from plugin.sdk.plugin import timer_interval
8484

8585
@timer_interval(
8686
id="cleanup",
@@ -102,7 +102,7 @@ def cleanup(self, **_):
102102
メインシステムからのメッセージハンドラーを定義します。
103103

104104
```python
105-
from plugin.sdk.decorators import message
105+
from plugin.sdk.plugin import message
106106

107107
@message(
108108
id="handle_chat",
@@ -118,7 +118,7 @@ def handle_chat(self, text: str, sender: str, **_):
118118
カスタムイベントタイプの汎用イベントハンドラーです。
119119

120120
```python
121-
from plugin.sdk.decorators import on_event
121+
from plugin.sdk.plugin import on_event
122122

123123
@on_event(
124124
event_type="custom_event",

docs/ja/plugins/examples.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ import os
99
import shutil
1010
from pathlib import Path
1111
from typing import Any, Optional
12-
from plugin.sdk.base import NekoPluginBase
13-
from plugin.sdk.decorators import (
12+
from plugin.sdk.plugin import NekoPluginBase
13+
from plugin.sdk.plugin import (
1414
neko_plugin, plugin_entry, lifecycle, timer_interval
1515
)
1616

@@ -82,8 +82,8 @@ class FileProcessorPlugin(NekoPluginBase):
8282
import asyncio
8383
import aiohttp
8484
from typing import Any, Optional, Dict
85-
from plugin.sdk.base import NekoPluginBase
86-
from plugin.sdk.decorators import neko_plugin, plugin_entry, lifecycle
85+
from plugin.sdk.plugin import NekoPluginBase
86+
from plugin.sdk.plugin import neko_plugin, plugin_entry, lifecycle
8787

8888
@neko_plugin
8989
class APIClientPlugin(NekoPluginBase):
@@ -167,8 +167,8 @@ import json
167167
from datetime import datetime
168168
from pathlib import Path
169169
from typing import Any, Optional, Dict
170-
from plugin.sdk.base import NekoPluginBase
171-
from plugin.sdk.decorators import (
170+
from plugin.sdk.plugin import NekoPluginBase
171+
from plugin.sdk.plugin import (
172172
neko_plugin, plugin_entry, lifecycle, timer_interval
173173
)
174174

docs/ja/plugins/quick-start.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ supported = ">=0.1.0,<0.3.0"
4343
## ステップ 3: `__init__.py` の作成
4444

4545
```python
46-
from plugin.sdk.base import NekoPluginBase
47-
from plugin.sdk.decorators import neko_plugin, plugin_entry
46+
from plugin.sdk.plugin import NekoPluginBase
47+
from plugin.sdk.plugin import neko_plugin, plugin_entry
4848
from typing import Any
4949

5050
@neko_plugin

docs/ja/plugins/sdk-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
すべてのプラグインは `NekoPluginBase` を継承する必要があります。
66

77
```python
8-
from plugin.sdk.base import NekoPluginBase
8+
from plugin.sdk.plugin import NekoPluginBase
99

1010
class MyPlugin(NekoPluginBase):
1111
def __init__(self, ctx):

docs/plugins/decorators.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Decorators
22

3-
All decorators are imported from `plugin.sdk.decorators`.
3+
All decorators are imported from `plugin.sdk.plugin`.
44

55
## @neko_plugin
66

77
Marks a class as a N.E.K.O. plugin. Required on all plugin classes.
88

99
```python
10-
from plugin.sdk.decorators import neko_plugin
10+
from plugin.sdk.plugin import neko_plugin
1111

1212
@neko_plugin
1313
class MyPlugin(NekoPluginBase):
@@ -19,7 +19,7 @@ class MyPlugin(NekoPluginBase):
1919
Defines an externally callable entry point.
2020

2121
```python
22-
from plugin.sdk.decorators import plugin_entry
22+
from plugin.sdk.plugin import plugin_entry
2323

2424
@plugin_entry(
2525
id="process", # Entry point ID (required)
@@ -55,7 +55,7 @@ Always include `**_` in your function signature to capture unused parameters gra
5555
Defines lifecycle event handlers.
5656

5757
```python
58-
from plugin.sdk.decorators import lifecycle
58+
from plugin.sdk.plugin import lifecycle
5959

6060
@lifecycle(id="startup")
6161
def on_startup(self, **_):
@@ -80,7 +80,7 @@ Valid lifecycle IDs: `startup`, `shutdown`, `reload`.
8080
Defines a scheduled task that executes at fixed intervals.
8181

8282
```python
83-
from plugin.sdk.decorators import timer_interval
83+
from plugin.sdk.plugin import timer_interval
8484

8585
@timer_interval(
8686
id="cleanup",
@@ -102,7 +102,7 @@ Timer tasks run in separate threads. Exceptions are logged but don't stop the ti
102102
Defines a handler for messages from the main system.
103103

104104
```python
105-
from plugin.sdk.decorators import message
105+
from plugin.sdk.plugin import message
106106

107107
@message(
108108
id="handle_chat",
@@ -118,7 +118,7 @@ def handle_chat(self, text: str, sender: str, **_):
118118
Generic event handler for custom event types.
119119

120120
```python
121-
from plugin.sdk.decorators import on_event
121+
from plugin.sdk.plugin import on_event
122122

123123
@on_event(
124124
event_type="custom_event",

docs/plugins/examples.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ import os
99
import shutil
1010
from pathlib import Path
1111
from typing import Any, Optional
12-
from plugin.sdk.base import NekoPluginBase
13-
from plugin.sdk.decorators import (
12+
from plugin.sdk.plugin import NekoPluginBase
13+
from plugin.sdk.plugin import (
1414
neko_plugin, plugin_entry, lifecycle, timer_interval
1515
)
1616

@@ -82,8 +82,8 @@ A plugin that calls external APIs with async support and batch operations.
8282
import asyncio
8383
import aiohttp
8484
from typing import Any, Optional, Dict
85-
from plugin.sdk.base import NekoPluginBase
86-
from plugin.sdk.decorators import neko_plugin, plugin_entry, lifecycle
85+
from plugin.sdk.plugin import NekoPluginBase
86+
from plugin.sdk.plugin import neko_plugin, plugin_entry, lifecycle
8787

8888
@neko_plugin
8989
class APIClientPlugin(NekoPluginBase):
@@ -167,8 +167,8 @@ import json
167167
from datetime import datetime
168168
from pathlib import Path
169169
from typing import Any, Optional, Dict
170-
from plugin.sdk.base import NekoPluginBase
171-
from plugin.sdk.decorators import (
170+
from plugin.sdk.plugin import NekoPluginBase
171+
from plugin.sdk.plugin import (
172172
neko_plugin, plugin_entry, lifecycle, timer_interval
173173
)
174174

docs/plugins/quick-start.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ supported = ">=0.1.0,<0.3.0"
4343
## Step 3: Create `__init__.py`
4444

4545
```python
46-
from plugin.sdk.base import NekoPluginBase
47-
from plugin.sdk.decorators import neko_plugin, plugin_entry
46+
from plugin.sdk.plugin import NekoPluginBase
47+
from plugin.sdk.plugin import neko_plugin, plugin_entry
4848
from typing import Any
4949

5050
@neko_plugin

docs/plugins/sdk-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
All plugins must inherit from `NekoPluginBase`.
66

77
```python
8-
from plugin.sdk.base import NekoPluginBase
8+
from plugin.sdk.plugin import NekoPluginBase
99

1010
class MyPlugin(NekoPluginBase):
1111
def __init__(self, ctx):

docs/zh-CN/plugins/decorators.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# 装饰器
22

3-
所有装饰器均从 `plugin.sdk.decorators` 导入。
3+
所有装饰器均从 `plugin.sdk.plugin` 导入。
44

55
## @neko_plugin
66

77
将类标记为 N.E.K.O. 插件。所有插件类都必须使用此装饰器。
88

99
```python
10-
from plugin.sdk.decorators import neko_plugin
10+
from plugin.sdk.plugin import neko_plugin
1111

1212
@neko_plugin
1313
class MyPlugin(NekoPluginBase):
@@ -19,7 +19,7 @@ class MyPlugin(NekoPluginBase):
1919
定义一个可外部调用的入口点。
2020

2121
```python
22-
from plugin.sdk.decorators import plugin_entry
22+
from plugin.sdk.plugin import plugin_entry
2323

2424
@plugin_entry(
2525
id="process", # 入口点 ID(必需)
@@ -55,7 +55,7 @@ def process(self, data: str, **_):
5555
定义生命周期事件处理器。
5656

5757
```python
58-
from plugin.sdk.decorators import lifecycle
58+
from plugin.sdk.plugin import lifecycle
5959

6060
@lifecycle(id="startup")
6161
def on_startup(self, **_):
@@ -80,7 +80,7 @@ def on_reload(self, **_):
8080
定义按固定间隔执行的定时任务。
8181

8282
```python
83-
from plugin.sdk.decorators import timer_interval
83+
from plugin.sdk.plugin import timer_interval
8484

8585
@timer_interval(
8686
id="cleanup",
@@ -102,7 +102,7 @@ def cleanup(self, **_):
102102
定义处理来自主系统消息的处理器。
103103

104104
```python
105-
from plugin.sdk.decorators import message
105+
from plugin.sdk.plugin import message
106106

107107
@message(
108108
id="handle_chat",
@@ -118,7 +118,7 @@ def handle_chat(self, text: str, sender: str, **_):
118118
通用事件处理器,用于自定义事件类型。
119119

120120
```python
121-
from plugin.sdk.decorators import on_event
121+
from plugin.sdk.plugin import on_event
122122

123123
@on_event(
124124
event_type="custom_event",

docs/zh-CN/plugins/examples.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ import os
99
import shutil
1010
from pathlib import Path
1111
from typing import Any, Optional
12-
from plugin.sdk.base import NekoPluginBase
13-
from plugin.sdk.decorators import (
12+
from plugin.sdk.plugin import NekoPluginBase
13+
from plugin.sdk.plugin import (
1414
neko_plugin, plugin_entry, lifecycle, timer_interval
1515
)
1616

@@ -82,8 +82,8 @@ class FileProcessorPlugin(NekoPluginBase):
8282
import asyncio
8383
import aiohttp
8484
from typing import Any, Optional, Dict
85-
from plugin.sdk.base import NekoPluginBase
86-
from plugin.sdk.decorators import neko_plugin, plugin_entry, lifecycle
85+
from plugin.sdk.plugin import NekoPluginBase
86+
from plugin.sdk.plugin import neko_plugin, plugin_entry, lifecycle
8787

8888
@neko_plugin
8989
class APIClientPlugin(NekoPluginBase):
@@ -167,8 +167,8 @@ import json
167167
from datetime import datetime
168168
from pathlib import Path
169169
from typing import Any, Optional, Dict
170-
from plugin.sdk.base import NekoPluginBase
171-
from plugin.sdk.decorators import (
170+
from plugin.sdk.plugin import NekoPluginBase
171+
from plugin.sdk.plugin import (
172172
neko_plugin, plugin_entry, lifecycle, timer_interval
173173
)
174174

0 commit comments

Comments
 (0)