nonebot-plugin-dialectlist 1.3.3__tar.gz → 2.0.0__tar.gz

nonebot_plugin_dialectlist-2.0.0/PKG-INFO

@@ -0,0 +1,148 @@
+Metadata-Version: 2.1
+Name: nonebot_plugin_dialectlist
+Version: 2.0.0
+Summary: Default template for PDM package
+Author-email: Chen_Xu233 <woyerpa@outlook.com>
+License: MIT
+Requires-Python: <4.0,>=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: nonebot2>=2.3.1
+Requires-Dist: nonebot-plugin-chatrecorder>=0.6.0
+Requires-Dist: pygal>=3.0.4
+Requires-Dist: requests>=2.32.3
+Requires-Dist: nonebot-plugin-apscheduler>=0.4.0
+Requires-Dist: nonebot-plugin-alconna>=0.46.6
+Requires-Dist: nonebot-plugin-cesaa>=0.4.0
+Requires-Dist: nonebot-plugin-userinfo>=0.2.4
+Provides-Extra: dev
+Requires-Dist: ruff>=0.4.9; extra == "dev"
+
+<div align="center">
+  <a href="https://v2.nonebot.dev/store"><img src="https://s2.loli.net/2022/06/16/opBDE8Swad5rU3n.png" width="180" height="180" alt="NoneBotPluginLogo"></a>
+  <br>
+  <p><img src="https://s2.loli.net/2022/06/16/xsVUGRrkbn1ljTD.png" width="240" alt="NoneBotPluginText"></p>
+</div>
+
+<div align="center">
+
+# 话痨排行榜
+nonebot-plugin-dialectlist
+
+\>💬**看看群友们这些天在群里水了多少话**💬<
+</div>
+
+## 💿安装
+
+通过`pip`或`nb`安装；
+
+>**通过 pip **安装
+
+`pip install nonebot-plugin-dialectlist`
+
+>**通过 nb **安装
+
+`nb plugin install nonebot-plugin-dialectlist`
+
+### ✅插件依赖于
+
+1. [nonebot-plugin-datastore](https://github.com/he0119/nonebot-plugin-datastore) ————储存历史的消息
+2. saa 和 定时管理 （下次写个更清晰的）
+  
+## ⚙配置
+
+需要**提前配置**本插件所**依赖的插件**！
+
+在 .env 中，可以添加以下配置项
+```python
+dialectlist__string_format = '第{index}名：\n{nickname},{chatdatanum}条消息、n' #消息格式
+dialectlist__string_suffix_format = '你们的职业是水群吗？————MYX\n 计算花费时间：{timecost}秒' #消息后缀格式
+dialectlist__get_num = 10 #获取人数数量
+dialectlist__visualization = True #是否可视化
+dialectlist__visualization_type = '圆环图' #可视化方案
+dialectlist__font = 'SimHei'#字体格式
+dialectlist__excluded_people = []#排除的人的 QQ 号（或频道号？（未经测试）)
+dialectlist__excluded_self = True #是否排除机器人自己 QQ
+```
+💭也可以不进行配置，这将会使插件按照默认配置运行
+
+ ### ⚠ 注意！！
+ 
+  需要提前安装好 [GTK+](https://github.com/tschoonj/GTK-for-Windows-Runtime-Environment-Installer)（仅 Windows 环境下需要安装 GTK+)
+  
+  在 Windows 以外的环境中可能不存在插件默认的字体！请自行改为系统中拥有的字体！
+
+## 🗨命令
+__！！注意！！__
+新版本指令调用方式改变，改为更易理解也更好打的 B 话榜。
+所以下面的调用需要把群话痨改成 B 话，排行榜改成榜。
+即 群话痨 -> B 话 ， 排行榜 -> 榜
+比如 今日群话痨排行榜 -> 今日 B 话榜
+以此类推。
+
+-`/群话痨排行榜` ————看看有史以来（机器人存在以来）群友们发了多少消息！
+
+-`/今日群话痨排行榜` ————看看今天的群友发了多少消息！
+
+-`/昨日群话痨排行榜` ————看看昨天的群友发了多少消息！
+
+-`/前日群话痨排行榜` ————看看前天的群友发了多少消息！
+
+-`/本周群话痨排行榜` ————看看本周的群友发了多少消息！
+  
+-`/上周群话痨排行榜` ————看看上周的群友发了多少消息！
+
+-`/本月群话痨排行榜` ————看看这个月的群友发了多少消息！
+
+-`/年度群话痨排行榜` ————看看今年的群友发了多少消息！
+
+-`/历史群话痨排行榜` ————看看历史上（机器人存在以来）的群友发了多少消息！
+
+  
+## 📖版本
+  
+### V1.0
+  
+  - 看看群里群友能有多话痨
+  
+### V1.1
+  
+  - 支持频道咯！(*^_^*)
+  
+### V1.2
+  
+  - 排行榜可视化
+  
+### V1.3
+
+  - 添加了一些可配置项
+  
+### V1.4
+
+  - 适配新版本的 chatrecorder, 暂时停止频道支持
+
+### V2.0
+
+  - 理论支持全平台！暂停图片支持。
+
+## 💧另外
+
+### 感谢
+
+本插件的__init__.py 中的处理函数参考了词云中的方法 ~~（其实大部分都是 Ctrl+C Ctr+V）~~
+
+[nonebot-plugin-wordcloud](https://github.com/he0119/nonebot-plugin-wordcloud)
+  
+## TODO
+
+- [x] 适配全平台
+
+- [ ] 私聊的查询（超级用户可以任意查询群聊的信息）
+
+- [ ] 关键词查询
+
+- [ ] 尝试利用 jinja2 模板引擎制作可视化图片 ((（真的可以吗？))
+  
+ 待补充。.....
+
+## 题外话
+~~整个项目快被我写成屎山了~~

nonebot_plugin_dialectlist-2.0.0/README.md

@@ -0,0 +1,129 @@
+<div align="center">
+  <a href="https://v2.nonebot.dev/store"><img src="https://s2.loli.net/2022/06/16/opBDE8Swad5rU3n.png" width="180" height="180" alt="NoneBotPluginLogo"></a>
+  <br>
+  <p><img src="https://s2.loli.net/2022/06/16/xsVUGRrkbn1ljTD.png" width="240" alt="NoneBotPluginText"></p>
+</div>
+
+<div align="center">
+
+# 话痨排行榜
+nonebot-plugin-dialectlist
+
+\>💬**看看群友们这些天在群里水了多少话**💬<
+</div>
+
+## 💿安装
+
+通过`pip`或`nb`安装；
+
+>**通过 pip **安装
+
+`pip install nonebot-plugin-dialectlist`
+
+>**通过 nb **安装
+
+`nb plugin install nonebot-plugin-dialectlist`
+
+### ✅插件依赖于
+
+1. [nonebot-plugin-datastore](https://github.com/he0119/nonebot-plugin-datastore) ————储存历史的消息
+2. saa 和 定时管理 （下次写个更清晰的）
+  
+## ⚙配置
+
+需要**提前配置**本插件所**依赖的插件**！
+
+在 .env 中，可以添加以下配置项
+```python
+dialectlist__string_format = '第{index}名：\n{nickname},{chatdatanum}条消息、n' #消息格式
+dialectlist__string_suffix_format = '你们的职业是水群吗？————MYX\n 计算花费时间：{timecost}秒' #消息后缀格式
+dialectlist__get_num = 10 #获取人数数量
+dialectlist__visualization = True #是否可视化
+dialectlist__visualization_type = '圆环图' #可视化方案
+dialectlist__font = 'SimHei'#字体格式
+dialectlist__excluded_people = []#排除的人的 QQ 号（或频道号？（未经测试）)
+dialectlist__excluded_self = True #是否排除机器人自己 QQ
+```
+💭也可以不进行配置，这将会使插件按照默认配置运行
+
+ ### ⚠ 注意！！
+ 
+  需要提前安装好 [GTK+](https://github.com/tschoonj/GTK-for-Windows-Runtime-Environment-Installer)（仅 Windows 环境下需要安装 GTK+)
+  
+  在 Windows 以外的环境中可能不存在插件默认的字体！请自行改为系统中拥有的字体！
+
+## 🗨命令
+__！！注意！！__
+新版本指令调用方式改变，改为更易理解也更好打的 B 话榜。
+所以下面的调用需要把群话痨改成 B 话，排行榜改成榜。
+即 群话痨 -> B 话 ， 排行榜 -> 榜
+比如 今日群话痨排行榜 -> 今日 B 话榜
+以此类推。
+
+-`/群话痨排行榜` ————看看有史以来（机器人存在以来）群友们发了多少消息！
+
+-`/今日群话痨排行榜` ————看看今天的群友发了多少消息！
+
+-`/昨日群话痨排行榜` ————看看昨天的群友发了多少消息！
+
+-`/前日群话痨排行榜` ————看看前天的群友发了多少消息！
+
+-`/本周群话痨排行榜` ————看看本周的群友发了多少消息！
+  
+-`/上周群话痨排行榜` ————看看上周的群友发了多少消息！
+
+-`/本月群话痨排行榜` ————看看这个月的群友发了多少消息！
+
+-`/年度群话痨排行榜` ————看看今年的群友发了多少消息！
+
+-`/历史群话痨排行榜` ————看看历史上（机器人存在以来）的群友发了多少消息！
+
+  
+## 📖版本
+  
+### V1.0
+  
+  - 看看群里群友能有多话痨
+  
+### V1.1
+  
+  - 支持频道咯！(*^_^*)
+  
+### V1.2
+  
+  - 排行榜可视化
+  
+### V1.3
+
+  - 添加了一些可配置项
+  
+### V1.4
+
+  - 适配新版本的 chatrecorder, 暂时停止频道支持
+
+### V2.0
+
+  - 理论支持全平台！暂停图片支持。
+
+## 💧另外
+
+### 感谢
+
+本插件的__init__.py 中的处理函数参考了词云中的方法 ~~（其实大部分都是 Ctrl+C Ctr+V）~~
+
+[nonebot-plugin-wordcloud](https://github.com/he0119/nonebot-plugin-wordcloud)
+  
+## TODO
+
+- [x] 适配全平台
+
+- [ ] 私聊的查询（超级用户可以任意查询群聊的信息）
+
+- [ ] 关键词查询
+
+- [ ] 尝试利用 jinja2 模板引擎制作可视化图片 ((（真的可以吗？))
+  
+ 待补充。.....
+
+## 题外话
+~~整个项目快被我写成屎山了~~

nonebot_plugin_dialectlist-2.0.0/nonebot_plugin_dialectlist/__init__.py

@@ -0,0 +1,265 @@
+from nonebot import require
+
+require("nonebot_plugin_chatrecorder")
+require("nonebot_plugin_apscheduler")
+require("nonebot_plugin_userinfo")
+require("nonebot_plugin_alconna")
+require("nonebot_plugin_cesaa")
+
+import re
+import os
+import time
+
+import nonebot_plugin_saa as saa
+
+from typing import Tuple, Union, Optional, List
+from datetime import datetime, timedelta
+from arclet.alconna import ArparmaBehavior
+from arclet.alconna.arparma import Arparma
+
+from nonebot import on_command, get_driver
+from nonebot.log import logger
+from nonebot.params import Command, CommandArg, Arg, Depends
+from nonebot.typing import T_State
+from nonebot.matcher import Matcher
+from nonebot import get_driver
+from nonebot.adapters import Bot, Event, Message
+from nonebot.params import Arg, Depends
+from nonebot.permission import SUPERUSER
+from nonebot.plugin import PluginMetadata, inherit_supported_adapters
+from nonebot.typing import T_State
+from nonebot_plugin_alconna import (
+    Alconna,
+    AlconnaMatch,
+    AlconnaMatcher,
+    AlconnaQuery,
+    Args,
+    Match,
+    Option,
+    Query,
+    image_fetch,
+    on_alconna,
+    store_true,
+)
+
+from nonebot_plugin_chatrecorder import get_message_records
+from nonebot_plugin_userinfo import EventUserInfo, UserInfo, get_user_info
+from nonebot_plugin_session import Session, SessionIdType, extract_session
+from nonebot_plugin_cesaa import get_messages_plain_text
+
+
+# from . import migrations #抄词云的部分代码，还不知道这有什么用
+# from .function import *
+from .config import Config, plugin_config
+from .utils import (
+    get_datetime_fromisoformat_with_timezone,
+    get_datetime_now_with_timezone,
+    got_rank,
+    msg_counter,
+    persist_id2user_id,
+)
+
+with open(os.path.dirname(__file__) + "/usage.md") as f:
+    usage = f.read()
+
+__plugin_meta__ = PluginMetadata(
+    name="B话排行榜",
+    description="调查群U的B话数量，以一定的顺序排序后排序出来。",
+    usage=usage,
+    homepage="https://github.com/ChenXu233/nonebot_plugin_dialectlist",
+    type="application",
+    supported_adapters=inherit_supported_adapters(
+        "nonebot_plugin_chatrecorder", "nonebot_plugin_saa", "nonebot_plugin_alconna"
+    ),
+    config=Config,
+    # extra={"orm_version_location": migrations},
+)
+
+
+# 抄的词云，不过真的很适合B话榜。
+class SameTime(ArparmaBehavior):
+    def operate(self, interface: Arparma):
+        type = interface.query("type")
+        time = interface.query("time")
+        if type is None and time:
+            interface.behave_fail()
+
+
+rank_cmd = on_alconna(
+    Alconna(
+        "B话榜",
+        Args["type?", ["今日", "昨日", "本周", "上周", "本月", "上月", "年度", "历史"]][
+            "time?", str
+        ],
+        behaviors=[SameTime()],
+    ),
+    use_cmd_start=True,
+)
+
+
+def wrapper(slot: Union[int, str], content: Optional[str]) -> str:
+    if slot == "type" and content:
+        return content
+    return ""  # pragma: no cover
+
+
+rank_cmd.shortcut(
+    r"(?P<type>今日|昨日|本周|上周|本月|上月|年度|历史)B话榜",
+    {
+        "prefix": True,
+        "command": "B话榜 ",
+        "wrapper": wrapper,
+        "args": ["{type}"],
+    },
+)
+
+
+def parse_datetime(key: str):
+    """解析数字，并将结果存入 state 中"""
+
+    async def _key_parser(
+        matcher: AlconnaMatcher,
+        state: T_State,
+        input: Union[datetime, Message] = Arg(key),
+    ):
+        if isinstance(input, datetime):
+            return
+
+        plaintext = input.extract_plain_text()
+        try:
+            state[key] = get_datetime_fromisoformat_with_timezone(plaintext)
+        except ValueError:
+            await matcher.reject_arg(key, "请输入正确的日期，不然我没法理解呢！")
+
+    return _key_parser
+
+
+# TODO 处理函数更新
+# 参考词云
+
+
+# 这段函数完全抄的词云
+@rank_cmd.handle()
+async def _group_message(
+    state: T_State,
+    type: Optional[str] = None,
+    time: Optional[str] = None,
+):
+
+    dt = get_datetime_now_with_timezone()
+
+    if not type:
+        await rank_cmd.finish(__plugin_meta__.usage)
+
+    dt = get_datetime_now_with_timezone()
+
+    if type == "今日":
+        state["start"] = dt.replace(hour=0, minute=0, second=0, microsecond=0)
+        state["stop"] = dt
+    elif type == "昨日":
+        state["stop"] = dt.replace(hour=0, minute=0, second=0, microsecond=0)
+        state["start"] = state["stop"] - timedelta(days=1)
+    elif type == "本周":
+        state["start"] = dt.replace(
+            hour=0, minute=0, second=0, microsecond=0
+        ) - timedelta(days=dt.weekday())
+        state["stop"] = dt
+    elif type == "上周":
+        state["stop"] = dt.replace(
+            hour=0, minute=0, second=0, microsecond=0
+        ) - timedelta(days=dt.weekday())
+        state["start"] = state["stop"] - timedelta(days=7)
+    elif type == "本月":
+        state["start"] = dt.replace(day=1, hour=0, minute=0, second=0, microsecond=0)
+        state["stop"] = dt
+    elif type == "上月":
+        state["stop"] = dt.replace(
+            day=1, hour=0, minute=0, second=0, microsecond=0
+        ) - timedelta(microseconds=1)
+        state["start"] = state["stop"].replace(
+            day=1, hour=0, minute=0, second=0, microsecond=0
+        )
+    elif type == "年度":
+        state["start"] = dt.replace(
+            month=1, day=1, hour=0, minute=0, second=0, microsecond=0
+        )
+        state["stop"] = dt
+    elif type == "历史":
+        if time:
+            plaintext = time
+            if match := re.match(r"^(.+?)(?:~(.+))?$", plaintext):
+                start = match[1]
+                stop = match[2]
+                try:
+                    state["start"] = get_datetime_fromisoformat_with_timezone(start)
+                    if stop:
+                        state["stop"] = get_datetime_fromisoformat_with_timezone(stop)
+                    else:
+                        # 如果没有指定结束日期，则认为是所给日期的当天的词云
+                        state["start"] = state["start"].replace(
+                            hour=0, minute=0, second=0, microsecond=0
+                        )
+                        state["stop"] = state["start"] + timedelta(days=1)
+                except ValueError:
+                    await rank_cmd.finish("请输入正确的日期，不然我没法理解呢！")
+
+
+@rank_cmd.got(
+    "start",
+    prompt="请输入你要查询的起始日期（如 2022-01-01）",
+    parameterless=[Depends(parse_datetime("start"))],
+)
+@rank_cmd.got(
+    "stop",
+    prompt="请输入你要查询的结束日期（如 2022-02-22）",
+    parameterless=[Depends(parse_datetime("stop"))],
+)
+async def handle_rank(
+    bot: Bot,
+    event: Event,
+    session: Session = Depends(extract_session),
+    start: datetime = Arg(),
+    stop: datetime = Arg(),
+):
+    """生成词云"""
+    messages = await get_message_records(
+        session=session,
+        id_type=SessionIdType.GROUP,
+        include_bot_id=False,
+        include_bot_type=False,
+        types=["message"],  # 排除机器人自己发的消息
+        time_start=start,
+        time_stop=stop,
+        exclude_id1s=plugin_config.excluded_people,
+    )
+
+    rank = got_rank(msg_counter(messages))
+    ids = await persist_id2user_id([int(i[0]) for i in rank])
+    for i in range(len(rank)):
+        rank[i][0] = str(ids[i])
+
+    string: str = ""
+    nicknames: List = []
+    for i in rank:
+        if user_info := await get_user_info(bot, event, user_id=str(i[0])):
+            (
+                nicknames.append(user_info.user_displayname)
+                if user_info.user_displayname
+                else (
+                    nicknames.append(user_info.user_name)
+                    if user_info.user_name
+                    else nicknames.append(user_info.user_id)
+                )
+            )
+        else:
+            nicknames.append(None)
+    logger.debug(nicknames)
+    for i in range(len(rank)):
+        index = i + 1
+        nickname, chatdatanum = nicknames[i], rank[i][1]
+        str_example = plugin_config.string_format.format(
+            index=index, nickname=nickname, chatdatanum=chatdatanum
+        )
+        string += str_example
+
+    await saa.Text(string).finish(reply=True)

nonebot_plugin_dialectlist-2.0.0/nonebot_plugin_dialectlist/config.py

@@ -0,0 +1,29 @@
+from typing import Optional, Literal, List
+from nonebot import get_driver, get_plugin_config
+from pydantic import BaseModel, field_validator
+
+
+class ScopedConfig(BaseModel):
+    font: str = "SimHei"  # 字体格式
+    get_num: int = 5  # 获取人数数量
+    timezone: Optional[str] = "Asia/Shanghai"
+    excluded_self: bool = True
+    string_format: str = "第{index}名：\n{nickname},{chatdatanum}条消息\n"  # 消息格式
+    visualization: bool = True  # 是否可视化
+    excluded_people: List[str] = []  # 排除的人的QQ号
+    visualization_type: Literal["饼图", "圆环图", "柱状图"] = "圆环图"  # 可视化方案
+
+    @field_validator("get_num")
+    @classmethod
+    def check_priority(cls, v: int) -> int:
+        if v >= 1:
+            return v
+        raise ValueError("表中的人数必须大于一")
+
+
+class Config(BaseModel):
+    dialectlist: ScopedConfig = ScopedConfig()
+
+
+global_config = get_driver().config
+plugin_config = get_plugin_config(Config).dialectlist