mirror of
https://github.com/LiteyukiStudio/nonebot-plugin-marshoai.git
synced 2025-08-02 14:49:51 +00:00
✨ 添加开发文档和 API 文档的初始结构；更新 .gitignore 以排除生成的文档目录
This commit is contained in:
45
docs/zh/dev/api/tools/marshoai_meogirl/index.md
Normal file
45
docs/zh/dev/api/tools/marshoai_meogirl/index.md
Normal file
@ -0,0 +1,45 @@
|
||||
---
|
||||
title: index
|
||||
collapsed: true
|
||||
---
|
||||
# **模块** `nonebot_plugin_marshoai.tools.marshoai_meogirl`
|
||||
|
||||
---
|
||||
### ***async func*** `meogirl()`
|
||||
|
||||
|
||||
<details>
|
||||
<summary> <b>源代码</b> 或 <a href='https://github.com/LiteyukiStudio/nonebot-plugin-marshoai/tree/main/nonebot_plugin_marshoai/tools/marshoai_meogirl/__init__.py#L5' target='_blank'>在GitHub上查看</a></summary>
|
||||
|
||||
```python
|
||||
async def meogirl():
|
||||
return mg_info.meogirl()
|
||||
```
|
||||
</details>
|
||||
|
||||
---
|
||||
### ***async func*** `search(msg: str, num: int = 3)`
|
||||
|
||||
|
||||
<details>
|
||||
<summary> <b>源代码</b> 或 <a href='https://github.com/LiteyukiStudio/nonebot-plugin-marshoai/tree/main/nonebot_plugin_marshoai/tools/marshoai_meogirl/__init__.py#L10' target='_blank'>在GitHub上查看</a></summary>
|
||||
|
||||
```python
|
||||
async def search(msg: str, num: int=3):
|
||||
return str(await mg_search.search(msg, num))
|
||||
```
|
||||
</details>
|
||||
|
||||
---
|
||||
### ***async func*** `introduce(msg: str)`
|
||||
|
||||
|
||||
<details>
|
||||
<summary> <b>源代码</b> 或 <a href='https://github.com/LiteyukiStudio/nonebot-plugin-marshoai/tree/main/nonebot_plugin_marshoai/tools/marshoai_meogirl/__init__.py#L15' target='_blank'>在GitHub上查看</a></summary>
|
||||
|
||||
```python
|
||||
async def introduce(msg: str):
|
||||
return str(await mg_introduce.introduce(msg))
|
||||
```
|
||||
</details>
|
||||
|
||||
18
docs/zh/dev/api/tools/marshoai_meogirl/mg_info.md
Normal file
18
docs/zh/dev/api/tools/marshoai_meogirl/mg_info.md
Normal file
@ -0,0 +1,18 @@
|
||||
---
|
||||
title: mg_info
|
||||
---
|
||||
# **模块** `nonebot_plugin_marshoai.tools.marshoai_meogirl.mg_info`
|
||||
|
||||
---
|
||||
### ***func*** `meogirl()`
|
||||
|
||||
|
||||
<details>
|
||||
<summary> <b>源代码</b> 或 <a href='https://github.com/LiteyukiStudio/nonebot-plugin-marshoai/tree/main/nonebot_plugin_marshoai/tools/marshoai_meogirl/mg_info.py#L2' target='_blank'>在GitHub上查看</a></summary>
|
||||
|
||||
```python
|
||||
def meogirl():
|
||||
return 'Meogirl指的是"萌娘百科"(https://zh.moegirl.org.cn/ , 简称"萌百"), 是一个"万物皆可萌的百科全书！"; 同时, MarshoTools也配有"Meogirl"插件, 可调用萌百的api'
|
||||
```
|
||||
</details>
|
||||
|
||||
76
docs/zh/dev/api/tools/marshoai_meogirl/mg_introduce.md
Normal file
76
docs/zh/dev/api/tools/marshoai_meogirl/mg_introduce.md
Normal file
@ -0,0 +1,76 @@
|
||||
---
|
||||
title: mg_introduce
|
||||
---
|
||||
# **模块** `nonebot_plugin_marshoai.tools.marshoai_meogirl.mg_introduce`
|
||||
|
||||
---
|
||||
### ***async func*** `get_async_data(url)`
|
||||
|
||||
|
||||
<details>
|
||||
<summary> <b>源代码</b> 或 <a href='https://github.com/LiteyukiStudio/nonebot-plugin-marshoai/tree/main/nonebot_plugin_marshoai/tools/marshoai_meogirl/mg_introduce.py#L13' target='_blank'>在GitHub上查看</a></summary>
|
||||
|
||||
```python
|
||||
async def get_async_data(url):
|
||||
async with httpx.AsyncClient(timeout=None) as client:
|
||||
return await client.get(url, headers=headers)
|
||||
```
|
||||
</details>
|
||||
|
||||
---
|
||||
### ***async func*** `introduce(msg: str)`
|
||||
|
||||
|
||||
<details>
|
||||
<summary> <b>源代码</b> 或 <a href='https://github.com/LiteyukiStudio/nonebot-plugin-marshoai/tree/main/nonebot_plugin_marshoai/tools/marshoai_meogirl/mg_introduce.py#L18' target='_blank'>在GitHub上查看</a></summary>
|
||||
|
||||
```python
|
||||
async def introduce(msg: str):
|
||||
logger.info(f'介绍 : "{msg}" ...')
|
||||
result = ''
|
||||
url = 'https://mzh.moegirl.org.cn/' + urllib.parse.quote_plus(msg)
|
||||
response = await get_async_data(url)
|
||||
logger.success(f'连接"{url}"完成, 状态码 : {response.status_code}')
|
||||
soup = BeautifulSoup(response.text, 'html.parser')
|
||||
if response.status_code == 200:
|
||||
'\n 萌娘百科页面结构\n div#mw-content-text\n └── div#404search # 空白页面出现\n └── div.mw-parser-output # 正常页面\n └── div, p, table ... # 大量的解释项\n '
|
||||
result += msg + '\n'
|
||||
img = soup.find('img', class_='infobox-image')
|
||||
if img:
|
||||
result += f' \n'
|
||||
div = soup.find('div', class_='mw-parser-output')
|
||||
if div:
|
||||
p_tags = div.find_all('p')
|
||||
num = 0
|
||||
for p_tag in p_tags:
|
||||
p = str(p_tag)
|
||||
p = re.sub('<script.*?</script>|<style.*?</style>', '', p, flags=re.DOTALL)
|
||||
p = re.sub('<.*?>', '', p, flags=re.DOTALL)
|
||||
p = re.sub('\\[.*?]', '', p, flags=re.DOTALL)
|
||||
if p != '':
|
||||
result += str(p)
|
||||
num += 1
|
||||
if num >= 20:
|
||||
break
|
||||
return result
|
||||
elif response.status_code == 404:
|
||||
logger.info(f'未找到"{msg}", 进行搜索')
|
||||
from . import mg_search
|
||||
context = await mg_search.search(msg, 1)
|
||||
keyword = re.search('.*?\\n', context, flags=re.DOTALL).group()[:-1]
|
||||
logger.success(f'搜索完成, 打开"{keyword}"')
|
||||
return await introduce(keyword)
|
||||
elif response.status_code == 301:
|
||||
return f'未找到{msg}'
|
||||
else:
|
||||
logger.error(f'网络错误, 状态码 : {response.status_code}')
|
||||
return f'网络错误, 状态码 : {response.status_code}'
|
||||
```
|
||||
</details>
|
||||
|
||||
### var `keyword`
|
||||
|
||||
- **说明**: type: ignore
|
||||
|
||||
- **默认值**: `re.search('.*?\\n', context, flags=re.DOTALL).group()[:-1]`
|
||||
|
||||
73
docs/zh/dev/api/tools/marshoai_meogirl/mg_search.md
Normal file
73
docs/zh/dev/api/tools/marshoai_meogirl/mg_search.md
Normal file
@ -0,0 +1,73 @@
|
||||
---
|
||||
title: mg_search
|
||||
---
|
||||
# **模块** `nonebot_plugin_marshoai.tools.marshoai_meogirl.mg_search`
|
||||
|
||||
---
|
||||
### ***async func*** `get_async_data(url)`
|
||||
|
||||
|
||||
<details>
|
||||
<summary> <b>源代码</b> 或 <a href='https://github.com/LiteyukiStudio/nonebot-plugin-marshoai/tree/main/nonebot_plugin_marshoai/tools/marshoai_meogirl/mg_search.py#L12' target='_blank'>在GitHub上查看</a></summary>
|
||||
|
||||
```python
|
||||
async def get_async_data(url):
|
||||
async with httpx.AsyncClient(timeout=None) as client:
|
||||
return await client.get(url, headers=headers)
|
||||
```
|
||||
</details>
|
||||
|
||||
---
|
||||
### ***async func*** `search(msg: str, num: int)`
|
||||
|
||||
|
||||
<details>
|
||||
<summary> <b>源代码</b> 或 <a href='https://github.com/LiteyukiStudio/nonebot-plugin-marshoai/tree/main/nonebot_plugin_marshoai/tools/marshoai_meogirl/mg_search.py#L17' target='_blank'>在GitHub上查看</a></summary>
|
||||
|
||||
```python
|
||||
async def search(msg: str, num: int):
|
||||
logger.info(f'搜索 : "{msg}" ...')
|
||||
result = ''
|
||||
url = 'https://mzh.moegirl.org.cn/index.php?search=' + urllib.parse.quote_plus(msg)
|
||||
response = await get_async_data(url)
|
||||
logger.success(f'连接"{url}"完成, 状态码 : {response.status_code}')
|
||||
if response.status_code == 200:
|
||||
'\n 萌娘百科搜索页面结构\n div.searchresults\n └── p ...\n └── ul.mw-search-results # 若无, 证明无搜索结果\n └── li # 一个搜索结果\n └── div.mw-search-result-heading > a # 标题\n └── div.mw-searchresult # 内容\n └── div.mw-search-result-data\n └── li ...\n └── li ...\n '
|
||||
soup = BeautifulSoup(response.text, 'html.parser')
|
||||
ul_tag = soup.find('ul', class_='mw-search-results')
|
||||
if ul_tag:
|
||||
li_tags = ul_tag.find_all('li')
|
||||
for li_tag in li_tags:
|
||||
div_heading = li_tag.find('div', class_='mw-search-result-heading')
|
||||
if div_heading:
|
||||
a_tag = div_heading.find('a')
|
||||
result += a_tag['title'] + '\n'
|
||||
logger.info(f'搜索到 : "{a_tag['title']}"')
|
||||
div_result = li_tag.find('div', class_='searchresult')
|
||||
if div_result:
|
||||
content = str(div_result).replace('<div class="searchresult">', '').replace('</div>', '')
|
||||
content = content.replace('<span class="searchmatch">', '').replace('</span>', '')
|
||||
result += content + '\n'
|
||||
num -= 1
|
||||
if num == 0:
|
||||
break
|
||||
return result
|
||||
else:
|
||||
logger.info('无结果')
|
||||
return '无结果'
|
||||
elif response.status_code == 302:
|
||||
logger.info(f'"{msg}"已被重定向至"{response.headers.get('location')}"')
|
||||
from . import mg_introduce
|
||||
return await mg_introduce.introduce(msg)
|
||||
else:
|
||||
logger.error(f'网络错误, 状态码 : {response.status_code}')
|
||||
return f'网络错误, 状态码 : {response.status_code}'
|
||||
```
|
||||
</details>
|
||||
|
||||
### var `soup`
|
||||
|
||||
- **说明**:
|
||||
|
||||
- **默认值**: `BeautifulSoup(response.text, 'html.parser')`
|
||||
|
||||
Reference in New Issue
Block a user