nonebot-plugin-randpic 0.0.1__tar.gz

nonebot_plugin_randpic-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 HuParry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

nonebot_plugin_randpic-0.0.1/PKG-INFO

@@ -0,0 +1,157 @@
+Metadata-Version: 2.1
+Name: nonebot-plugin-randpic
+Version: 0.0.1
+Summary: 一个通过指令随机发送你存储的图片的插件
+Home-page: https://github.com/HuParry/nonebot-plugin-randpic
+License: MIT
+Author: HuParry
+Author-email: hu_parry@qq.com
+Requires-Python: >=3.8
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: asyncio (>=3.4.3)
+Requires-Dist: httpx (>=0.20.0,<1.0.0)
+Requires-Dist: nonebot-adapter-onebot (>=2.1.5)
+Requires-Dist: nonebot2 (>=2.0.0)
+Project-URL: Repository, https://github.com/HuParry/nonebot-plugin-randpic
+Description-Content-Type: text/markdown
+
+<div align="center">
+  <a href="https://v2.nonebot.dev/store"><img src="https://github.com/A-kirami/nonebot-plugin-template/blob/resources/nbp_logo.png" width="180" height="180" alt="NoneBotPluginLogo"></a>
+  <br>
+  <p><img src="https://github.com/A-kirami/nonebot-plugin-template/blob/resources/NoneBotPlugin.svg" width="240" alt="NoneBotPluginText"></p>
+</div>
+
+<div align="center">
+
+# nonebot-plugin-randpic
+
+_✨ 一个发送指令就能让你的 bot 发出对应指令的图片的插件 ✨_
+
+
+<a href="./LICENSE">
+    <img src="https://img.shields.io/github/license/HuParry/nonebot-plugin-randpic.svg" alt="license">
+</a>
+<a href="https://pypi.python.org/pypi/nonebot-plugin-randpic">
+    <img src="https://img.shields.io/pypi/v/nonebot-plugin-randpic.svg" alt="pypi">
+</a>
+<img src="https://img.shields.io/badge/python-3.8+-blue.svg" alt="python">
+
+</div>
+
+## 📖 介绍
+
+这是由 [nonebot-plugin-capoo](https://github.com/HuParry/nonebot-plugin-capoo) 插件衍生而来的随机发送图片的插件，从使用上来看，这个插件远优于那个插件。
+
+你可以很方便地直接通过在配置文件里设置好触发指令（支持多个触发指令）后，在群聊中发送对应指令，从而使 Bot 随机发送出你所存储的图片。
+
+插件除了能随机发送图片，还能在群聊内直接通过指令存储图片，同时为了避免重复加入同一张图片，该插件添加了 md5 码检查。
+
+随机发送图片是利用的 sqlite3 库里的随机选择指令。
+
+注意：插件版本更新时可能会对数据库表的结构进行更新，如果你更新插件后发现数据库有报错，那么可以试着删除 `data/randpic` 路径下的 `data.db` 文件，然后重新加载插件。
+
+该插件的运行逻辑是：
+- 自动在 Bot 项目根目录的 `data` 文件夹下创建一个 `randpic` 文件夹；
+- 在你预设指令（可以是多个）后，插件会检索指令，并在 `randpic` 目录下生成所有你预设命令作为名字的文件夹，同时生成一个 `data.db` 的数据库文件；
+- 之后你可以通过 Bot 存储图片，也可以直接在 `data/<预设命令>` 文件夹下存储图片。
+
+你可以在bot未启动期间任意修改图片文件夹内的所有内容，因为在启动bot后插件会自动做图片配置检查，因此你不用担心自己修改图片后会导致数据库与文件夹内容不同步。
+
+**但是在启动bot后不建议修改、删除以及添加图片**，否则可能会造成一些未知bug。
+
+不建议你存储过多图片（指几万张甚至更多），因为没做过存储大量图片的测试。
+
+有任何问题可提 issue，看到会及时回复，目前功能比较简单，以后会慢慢扩充。
+
+由于sqlite3库是同步数据库，日后将考虑更换成orm。
+
+## 💿 安装
+
+<details>
+<summary>使用 nb-cli 安装</summary>
+在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装
+
+    nb plugin install nonebot-plugin-randpic
+
+</details>
+
+<details>
+<summary>使用包管理器安装</summary>
+在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令
+
+<details>
+<summary>pip</summary>
+
+    pip install nonebot-plugin-randpic
+</details>
+<details>
+<summary>pdm</summary>
+
+    pdm add nonebot-plugin-randpic
+</details>
+<details>
+<summary>poetry</summary>
+
+    poetry add nonebot-plugin-randpic
+</details>
+<details>
+<summary>conda</summary>
+
+    conda install nonebot-plugin-randpic
+</details>
+
+打开 nonebot2 项目根目录下的 `pyproject.toml` 文件, 在 `[tool.nonebot]` 部分追加写入
+
+    plugins = ["nonebot_plugin_capoo"]
+
+</details>
+
+## ⚙️ 配置
+
+在 nonebot2 项目的`.env`文件中添加下表中的必填配置
+
+| 配置项 | 必填 |    默认值    |               说明                |
+|:---:|:----:|:---------:|:-------------------------------:|
+|  randpic_command_set   |  否  |  {"capoo"}  |  预设的触发指令，默认是capoo，即capoo触发发送图片  |
+
+例如这样配置：
+```
+randpic_command_set={"capoo", "马哥"}
+```
+
+## 🎉 使用
+### 指令表
+| 指令 | 权限 | 需要@ | 范围 |        说明         |
+|:-----:|:----:|:----:|:----:|:-----------------:|
+| `<你设置的指令>` | 群员 | 否 | 群聊 |   随机发送一张对应指令的图片   |
+| `添加<你设置的指令>` | 群管 | 否 | 群聊 | 让 bot 存储图片到对应文件夹下 |
+
+### 效果图
+#### `capoo` 指令
+<img src="./docs/preview.jpg" width="375" />
+
+#### `添加capoo` 指令
+<img src="./docs/preview2.jpg" width="375" />
+
+<img src="./docs/preview3.jpg" width="375" />
+
+#### `马哥` 指令
+<img src="./docs/mage1.png" width="375" />
+
+#### `添加马哥` 指令
+<img src="./docs/mage2.png" width="375" />
+
+<img src="./docs/mage3.png" width="375" />
+
+## TODO
+- [x] 指令触发 bot 发送图片
+- [x] 在 QQ 上让 bot 存储对应指令的图片
+- [x] 每次存储图片，判断图片是否已经存在，避免重复加入
+- [ ] 指定某个序号的图片发送
+- [X] 由该插件衍生成一个模板插件，即仅需修改参数就能发送别的图片

nonebot_plugin_randpic-0.0.1/README.md

@@ -0,0 +1,134 @@
+<div align="center">
+  <a href="https://v2.nonebot.dev/store"><img src="https://github.com/A-kirami/nonebot-plugin-template/blob/resources/nbp_logo.png" width="180" height="180" alt="NoneBotPluginLogo"></a>
+  <br>
+  <p><img src="https://github.com/A-kirami/nonebot-plugin-template/blob/resources/NoneBotPlugin.svg" width="240" alt="NoneBotPluginText"></p>
+</div>
+
+<div align="center">
+
+# nonebot-plugin-randpic
+
+_✨ 一个发送指令就能让你的 bot 发出对应指令的图片的插件 ✨_
+
+
+<a href="./LICENSE">
+    <img src="https://img.shields.io/github/license/HuParry/nonebot-plugin-randpic.svg" alt="license">
+</a>
+<a href="https://pypi.python.org/pypi/nonebot-plugin-randpic">
+    <img src="https://img.shields.io/pypi/v/nonebot-plugin-randpic.svg" alt="pypi">
+</a>
+<img src="https://img.shields.io/badge/python-3.8+-blue.svg" alt="python">
+
+</div>
+
+## 📖 介绍
+
+这是由 [nonebot-plugin-capoo](https://github.com/HuParry/nonebot-plugin-capoo) 插件衍生而来的随机发送图片的插件，从使用上来看，这个插件远优于那个插件。
+
+你可以很方便地直接通过在配置文件里设置好触发指令（支持多个触发指令）后，在群聊中发送对应指令，从而使 Bot 随机发送出你所存储的图片。
+
+插件除了能随机发送图片，还能在群聊内直接通过指令存储图片，同时为了避免重复加入同一张图片，该插件添加了 md5 码检查。
+
+随机发送图片是利用的 sqlite3 库里的随机选择指令。
+
+注意：插件版本更新时可能会对数据库表的结构进行更新，如果你更新插件后发现数据库有报错，那么可以试着删除 `data/randpic` 路径下的 `data.db` 文件，然后重新加载插件。
+
+该插件的运行逻辑是：
+- 自动在 Bot 项目根目录的 `data` 文件夹下创建一个 `randpic` 文件夹；
+- 在你预设指令（可以是多个）后，插件会检索指令，并在 `randpic` 目录下生成所有你预设命令作为名字的文件夹，同时生成一个 `data.db` 的数据库文件；
+- 之后你可以通过 Bot 存储图片，也可以直接在 `data/<预设命令>` 文件夹下存储图片。
+
+你可以在bot未启动期间任意修改图片文件夹内的所有内容，因为在启动bot后插件会自动做图片配置检查，因此你不用担心自己修改图片后会导致数据库与文件夹内容不同步。
+
+**但是在启动bot后不建议修改、删除以及添加图片**，否则可能会造成一些未知bug。
+
+不建议你存储过多图片（指几万张甚至更多），因为没做过存储大量图片的测试。
+
+有任何问题可提 issue，看到会及时回复，目前功能比较简单，以后会慢慢扩充。
+
+由于sqlite3库是同步数据库，日后将考虑更换成orm。
+
+## 💿 安装
+
+<details>
+<summary>使用 nb-cli 安装</summary>
+在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装
+
+    nb plugin install nonebot-plugin-randpic
+
+</details>
+
+<details>
+<summary>使用包管理器安装</summary>
+在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令
+
+<details>
+<summary>pip</summary>
+
+    pip install nonebot-plugin-randpic
+</details>
+<details>
+<summary>pdm</summary>
+
+    pdm add nonebot-plugin-randpic
+</details>
+<details>
+<summary>poetry</summary>
+
+    poetry add nonebot-plugin-randpic
+</details>
+<details>
+<summary>conda</summary>
+
+    conda install nonebot-plugin-randpic
+</details>
+
+打开 nonebot2 项目根目录下的 `pyproject.toml` 文件, 在 `[tool.nonebot]` 部分追加写入
+
+    plugins = ["nonebot_plugin_capoo"]
+
+</details>
+
+## ⚙️ 配置
+
+在 nonebot2 项目的`.env`文件中添加下表中的必填配置
+
+| 配置项 | 必填 |    默认值    |               说明                |
+|:---:|:----:|:---------:|:-------------------------------:|
+|  randpic_command_set   |  否  |  {"capoo"}  |  预设的触发指令，默认是capoo，即capoo触发发送图片  |
+
+例如这样配置：
+```
+randpic_command_set={"capoo", "马哥"}
+```
+
+## 🎉 使用
+### 指令表
+| 指令 | 权限 | 需要@ | 范围 |        说明         |
+|:-----:|:----:|:----:|:----:|:-----------------:|
+| `<你设置的指令>` | 群员 | 否 | 群聊 |   随机发送一张对应指令的图片   |
+| `添加<你设置的指令>` | 群管 | 否 | 群聊 | 让 bot 存储图片到对应文件夹下 |
+
+### 效果图
+#### `capoo` 指令
+<img src="./docs/preview.jpg" width="375" />
+
+#### `添加capoo` 指令
+<img src="./docs/preview2.jpg" width="375" />
+
+<img src="./docs/preview3.jpg" width="375" />
+
+#### `马哥` 指令
+<img src="./docs/mage1.png" width="375" />
+
+#### `添加马哥` 指令
+<img src="./docs/mage2.png" width="375" />
+
+<img src="./docs/mage3.png" width="375" />
+
+## TODO
+- [x] 指令触发 bot 发送图片
+- [x] 在 QQ 上让 bot 存储对应指令的图片
+- [x] 每次存储图片，判断图片是否已经存在，避免重复加入
+- [ ] 指定某个序号的图片发送
+- [X] 由该插件衍生成一个模板插件，即仅需修改参数就能发送别的图片

nonebot_plugin_randpic-0.0.1/nonebot_plugin_randpic/__init__.py

@@ -0,0 +1,176 @@
+from .config import Config
+from httpx import AsyncClient
+
+from nonebot.adapters.onebot.v11 import MessageSegment, Message, Event
+from nonebot.adapters.onebot.v11 import GROUP, GROUP_ADMIN, GROUP_OWNER
+from nonebot.plugin import on_fullmatch
+import os
+from nonebot.plugin import PluginMetadata
+from nonebot.params import Arg
+from pathlib import Path
+from typing import Tuple
+from nonebot import get_driver
+from nonebot.log import logger
+import asyncio
+import hashlib
+import sqlite3
+from nonebot.params import Fullmatch
+
+__plugin_meta__ = PluginMetadata(
+    name="随机发送图片",
+    description="发送自定义指令后bot会随机发出一张你所存储的图片",
+    usage="使用命令：<你设置的指令>",
+    type="application",
+    homepage="https://github.com/HuParry/nonebot-plugin-randpic",
+    config=Config,
+    supported_adapters={"nonebot.adapters.onebot.v11"},
+)
+
+randpic_command_set = Config.parse_obj(get_driver().config.dict()).randpic_command_set
+
+randpic_command_tuple: Tuple[str] = tuple(randpic_command_set)  # 形成指令元组
+randpic_command_add_tuple = tuple("添加" + tup for tup in randpic_command_tuple)  # 形成添加指令元组
+
+randpic_path = Path() / "data" / "randpic"
+randpic_command_path_tuple = tuple(randpic_path / command for command in randpic_command_tuple)  # 形成指令文件夹路径元组
+
+randpic_filename: str = 'randpic_{command}_{index}'
+
+connection: sqlite3.Connection
+
+# 激活驱动器
+driver = get_driver()
+
+
+@driver.on_startup
+async def _():
+    logger.info("正在检查文件...")
+    asyncio.create_task(create_file())
+    logger.info("文件检查完成，欢迎使用插件！")
+
+
+# 创建所需文件夹和数据库
+async def create_file():
+    # 先创建文件夹
+    for path in randpic_command_path_tuple:
+        if not path.exists():
+            logger.warning('未找到{path}文件夹，准备创建{path}文件夹...'.format(path=path))
+            path.mkdir(parents=True, exist_ok=True)
+    # 创建数据库，没有数据表创建数据表
+
+    global connection
+    connection = sqlite3.connect(randpic_path / "data.db")
+    cursor = connection.cursor()
+    # 没有表创建表
+    for command in randpic_command_tuple:
+        cursor.execute('DROP table if exists Pic_of_{command};'.format(command=command))
+        cursor.execute('''
+            CREATE TABLE IF NOT EXISTS Pic_of_{command} (
+                md5 TEXT PRIMARY KEY,
+                img_url TEXT
+            )
+            '''.format(command=command))
+        connection.commit()
+
+    # 读取所有文件夹文件，调整文件夹内图片，并写入数据库
+    for index in range(len(randpic_command_path_tuple)):
+        global randpic_filename
+        path: Path = randpic_command_path_tuple[index]
+        randpic_file_list = os.listdir(path)
+        randpic_file_list.sort()
+
+        for i in range(len(randpic_file_list)):
+            filename = randpic_file_list[i]
+            filename_without_extension, filename_extension = os.path.splitext(filename)
+            new_filename = randpic_filename.format(command=randpic_command_tuple[index],
+                                                   index=str(i+1))+(filename_extension if filename_extension != '' else '.jpg')
+            if filename_without_extension != randpic_filename:
+                os.rename(path / filename, path / new_filename)
+
+        # 将图片信息写入数据库
+        randpic_file_list = os.listdir(path)
+        randpic_file_list.sort()
+        for i in range(len(randpic_file_list)):
+            filename: str = randpic_file_list[i]
+            with (path / filename).open('rb') as f:
+                data = f.read()
+            fmd5 = hashlib.md5(data).hexdigest()
+
+            cursor = connection.cursor()
+            command: str = randpic_command_tuple[index]
+            cursor.execute(
+                'INSERT or REPLACE INTO Pic_of_{command}(md5, img_url) VALUES (?, ?)'.format(command=command),
+                (fmd5, str(Path() / command / filename)))
+            connection.commit()
+
+
+picture = on_fullmatch(randpic_command_tuple, permission=GROUP, priority=1, block=True)
+
+
+@picture.handle()
+async def pic(event: Event):
+    global connection
+    cursor = connection.cursor()
+    command = str(event.get_message()).strip()
+    cursor.execute(f'SELECT img_url FROM Pic_of_{command} ORDER BY RANDOM() limit 1')
+    data = cursor.fetchone()
+    if data is None:
+        await picture.finish('当前还没有图片!')
+    file_name = data[0]
+    img = randpic_path / file_name
+    try:
+        await picture.send(MessageSegment.image(img))
+    except:
+        await picture.send(f'{command}出不来了，稍后再试试吧~')
+
+
+add = on_fullmatch(randpic_command_add_tuple, permission=GROUP_ADMIN | GROUP_OWNER, priority=1, block=True)
+
+
+@add.got("pic", prompt="请发送图片！")
+async def add_pic(args: str = Fullmatch(), pic_list: Message = Arg('pic')):
+    global connection
+    cursor = connection.cursor()
+    command = args.replace('添加', '')
+
+    for pic in pic_list:
+        if pic.type != 'image':
+            await add.send(pic + MessageSegment.text("\n输入格式有误，请重新触发指令！"), at_sender=True)
+            continue
+        pic_url = pic.data['url']
+
+        async with AsyncClient() as client:
+            resp = await client.get(pic_url, timeout=5.0)
+
+        try:
+            resp.raise_for_status()
+        except:
+            await add.send(
+                pic +
+                MessageSegment.text('\n保存出错了，这张请重试')
+            )
+            continue
+
+        data = resp.content
+        fmd5 = hashlib.md5(data).hexdigest()
+
+        cursor.execute(f'SELECT img_url FROM Pic_of_{command} where md5=?', (fmd5,))
+        status = cursor.fetchone()
+
+        if status is not None:
+            await add.send(pic + Message('\n这张已经有了，不能重复添加！') )
+        else:
+            without_extension, extension = os.path.splitext(pic_url)
+            randpic_cur_picnum = len(os.listdir(randpic_path/command))
+            file_name = (randpic_filename.format(command=command, index=str(randpic_cur_picnum+1))
+                        +(extension if extension != '' else '.jpg'))
+            file_path = randpic_path/ command / file_name
+
+            try:
+                with file_path.open("wb") as f:
+                    f.write(data)
+                cursor.execute('insert into Pic_of_{command}(md5, img_url) values (?, ?)'.format(command=command),
+                               (fmd5, str(Path() / command / file_name)))
+                await add.send(pic + Message("\n导入成功！"), at_sender=True)
+            except:
+                await add.send(pic + Message("\n导入失败！"), at_sender=True)

nonebot_plugin_randpic-0.0.1/nonebot_plugin_randpic/config.py

@@ -0,0 +1,8 @@
+from pydantic import BaseModel, Extra
+from typing import Set
+
+
+class Config(BaseModel, extra=Extra.ignore):
+    randpic_command_set: Set[str] = {"capoo"}  # 指令集合
+
+

nonebot_plugin_randpic-0.0.1/pyproject.toml

@@ -0,0 +1,23 @@
+[tool.poetry]
+name = "nonebot-plugin-randpic"
+version = "0.0.1"
+description = "一个通过指令随机发送你存储的图片的插件"
+authors = ["HuParry <hu_parry@qq.com>"]
+license = "MIT"
+readme = "README.md"
+packages = [{include = "nonebot_plugin_randpic"}]
+homepage = "https://github.com/HuParry/nonebot-plugin-randpic"
+repository = "https://github.com/HuParry/nonebot-plugin-randpic"
+
+
+[tool.poetry.dependencies]
+python = ">=3.8"
+nonebot2 = ">=2.0.0"
+nonebot-adapter-onebot = ">=2.1.5"
+httpx = ">=0.20.0,<1.0.0"
+asyncio = ">=3.4.3"
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"