From 50056228b645d9e1ace88c9a8774c69c01935073 Mon Sep 17 00:00:00 2001
From: yanyongyu <yanyongyu_1@126.com>
Date: Mon, 9 Nov 2020 12:33:17 +0800
Subject: [PATCH] :memo: update plugin create

---
 docs/guide/creating-a-plugin.md | 21 +++++++++++++++++----
 1 file changed, 17 insertions(+), 4 deletions(-)

diff --git a/docs/guide/creating-a-plugin.md b/docs/guide/creating-a-plugin.md
index fab4694a..f33a4db6 100644
--- a/docs/guide/creating-a-plugin.md
+++ b/docs/guide/creating-a-plugin.md
@@ -71,7 +71,7 @@ foo
 
 #### config.py
 
-在该文件中使用 `pydantic` 定义插件所需要的配置项。
+在该文件中使用 `pydantic` 定义插件所需要的配置项以及类型。
 
 示例：
 
@@ -81,9 +81,6 @@ from pydantic import BaseSetting
 
 class Config(BaseSetting):
 
-    # nonebot config
-    superusers: Set[int]
-
     # plugin custom config
     plugin_setting: str = "default"
 
@@ -91,10 +88,26 @@ class Config(BaseSetting):
         extra = "ignore"
 ```
 
+并在 `__init__.py` 文件中添加以下行
+
+```python
+import nonebot
+from .config import Config
+
+global_config = nonebot.get_bot().config
+plugin_config = Config(**global_config.dict())
+```
+
+此时就可以通过 `plugin_config.plugin_setting` 获取到插件所需要的配置项了。
+
 #### data_source.py
 
 在该文件中编写数据获取函数。
 
+:::warning 警告
+数据获取应尽量使用**异步**处理！例如使用 [httpx](https://www.python-httpx.org/) 而非 [requests](https://requests.readthedocs.io/en/master/)
+:::
+
 #### model.py
 
 在该文件中编写数据库模型。