chickliu/quark-auto-save
1
0
Fork 0
mirror of https://github.com/Cp0204/quark-auto-save.git synced 2026-01-12 23:30:44 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

📝 更新类命名规范及贡献者信息

Browse Source
This commit is contained in:
Cp0204 2024-11-16 14:32:17 +08:00
parent 6fba6eefa9
commit de2ba4f0e4
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
media_servers/README.md
View File

@ -6,7 +6,7 @@
* 模块位于 `media_servers` 目录下. * 模块位于 `media_servers` 目录下.
* 每个模块是一个 `.py` 文件 (例如 `emby.py`, `plex.py`)，文件名小写。 * 每个模块是一个 `.py` 文件 (例如 `emby.py`, `plex.py`)，文件名小写。
* 每个模块文件包含一个与文件名对应的大驼峰命名法类（例如 `emby.py` 中的 `Emby` 类）。 * 每个模块文件包含一个与文件名对应的首字母大写命名类（例如 `emby.py` 中的 `Emby` 类）。
## 模块要求 ## 模块要求
@ -27,7 +27,7 @@
* **`run(self, task)`**：整个模块入口函数，处理模块逻辑。 * **`run(self, task)`**：整个模块入口函数，处理模块逻辑。
* `task` 是一个字典，包含任务信息。如果需要修改任务参数，返回修改后的 `task` 字典； * `task` 是一个字典，包含任务信息。如果需要修改任务参数，返回修改后的 `task` 字典；
* 无修改则不返回或返回 `False`。 * 无修改则不返回或返回 `None`。
## 模块示例 ## 模块示例
@ -84,4 +84,10 @@ docker run -d \
} }
``` ```
当模块代码正确赋值 `default_config` 时，首次运行会自动补充缺失的键。 当模块代码正确赋值 `default_config` 时，首次运行会自动补充缺失的键。
## 🤝 贡献者
| 模块 | 说明 | 贡献者 |
| ------- | -------------------- | --------------------------------------- |
| plex.py | 自动刷新 Plex 媒体库 | [zhazhayu](https://github.com/zhazhayu) |