nonebot-plugin-marshoai/docs/zh/dev/api/models.md

---
title: models
---
# **模块** `nonebot_plugin_marshoai.models`

### ***class*** `MarshoContext`
---
#### ***func*** `__init__(self)`


<details>
<summary> <b>源代码</b> 或 <a href='https://github.com/LiteyukiStudio/nonebot-plugin-marshoai/tree/main/nonebot_plugin_marshoai/models.py#L20' target='_blank'>在GitHub上查看</a></summary>

```python
def __init__(self):
    self.contents = {'private': {}, 'non-private': {}}
```
</details>

---
#### ***func*** `append(self, content, target_id: str, is_private: bool)`

**说明**: 往上下文中添加消息


<details>
<summary> <b>源代码</b> 或 <a href='https://github.com/LiteyukiStudio/nonebot-plugin-marshoai/tree/main/nonebot_plugin_marshoai/models.py#L26' target='_blank'>在GitHub上查看</a></summary>

```python
def append(self, content, target_id: str, is_private: bool):
    target_dict = self._get_target_dict(is_private)
    if target_id not in target_dict:
        target_dict[target_id] = []
    target_dict[target_id].append(content)
```
</details>

---
#### ***func*** `set_context(self, contexts, target_id: str, is_private: bool)`

**说明**: 设置上下文


<details>
<summary> <b>源代码</b> 或 <a href='https://github.com/LiteyukiStudio/nonebot-plugin-marshoai/tree/main/nonebot_plugin_marshoai/models.py#L35' target='_blank'>在GitHub上查看</a></summary>

```python
def set_context(self, contexts, target_id: str, is_private: bool):
    target_dict = self._get_target_dict(is_private)
    target_dict[target_id] = contexts
```
</details>

---
#### ***func*** `reset(self, target_id: str, is_private: bool)`

**说明**: 重置上下文


<details>
<summary> <b>源代码</b> 或 <a href='https://github.com/LiteyukiStudio/nonebot-plugin-marshoai/tree/main/nonebot_plugin_marshoai/models.py#L42' target='_blank'>在GitHub上查看</a></summary>

```python
def reset(self, target_id: str, is_private: bool):
    target_dict = self._get_target_dict(is_private)
    if target_id in target_dict:
        target_dict[target_id].clear()
```
</details>

---
#### ***func*** `build(self, target_id: str, is_private: bool) -> list`

**说明**: 构建返回的上下文，不包括系统消息


<details>
<summary> <b>源代码</b> 或 <a href='https://github.com/LiteyukiStudio/nonebot-plugin-marshoai/tree/main/nonebot_plugin_marshoai/models.py#L50' target='_blank'>在GitHub上查看</a></summary>

```python
def build(self, target_id: str, is_private: bool) -> list:
    target_dict = self._get_target_dict(is_private)
    if target_id not in target_dict:
        target_dict[target_id] = []
    return target_dict[target_id]
```
</details>

### ***class*** `MarshoTools`
---
#### ***func*** `__init__(self)`


<details>
<summary> <b>源代码</b> 或 <a href='https://github.com/LiteyukiStudio/nonebot-plugin-marshoai/tree/main/nonebot_plugin_marshoai/models.py#L65' target='_blank'>在GitHub上查看</a></summary>

```python
def __init__(self):
    self.tools_list = []
    self.imported_packages = {}
```
</details>

---
#### ***func*** `load_tools(self, tools_dir)`

**说明**: 从指定路径加载工具包


<details>
<summary> <b>源代码</b> 或 <a href='https://github.com/LiteyukiStudio/nonebot-plugin-marshoai/tree/main/nonebot_plugin_marshoai/models.py#L69' target='_blank'>在GitHub上查看</a></summary>

```python
def load_tools(self, tools_dir):
    if not os.path.exists(tools_dir):
        logger.error(f'工具集目录 {tools_dir} 不存在。')
        return
    for package_name in os.listdir(tools_dir):
        package_path = os.path.join(tools_dir, package_name)
        if package_name in config.marshoai_disabled_toolkits:
            logger.info(f'工具包 {package_name} 已被禁用。')
            continue
        if os.path.isdir(package_path) and os.path.exists(os.path.join(package_path, '__init__.py')):
            json_path = os.path.join(package_path, 'tools.json')
            if os.path.exists(json_path):
                try:
                    with open(json_path, 'r', encoding='utf-8') as json_file:
                        data = json.load(json_file)
                        for i in data:
                            self.tools_list.append(i)
                        spec = importlib.util.spec_from_file_location(package_name, os.path.join(package_path, '__init__.py'))
                        package = importlib.util.module_from_spec(spec)
                        self.imported_packages[package_name] = package
                        sys.modules[package_name] = package
                        spec.loader.exec_module(package)
                        logger.success(f'成功加载工具包 {package_name}')
                except json.JSONDecodeError as e:
                    logger.error(f'解码 JSON {json_path} 时发生错误: {e}')
                except Exception as e:
                    logger.error(f'加载工具包时发生错误: {e}')
                    traceback.print_exc()
            else:
                logger.warning(f'在工具包 {package_path} 下找不到tools.json，跳过加载。')
        else:
            logger.warning(f'{package_path} 不是有效的工具包路径，跳过加载。')
```
</details>

---
#### ***async func*** `call(self, full_function_name: str, args: dict)`

**说明**: 调用指定的函数


<details>
<summary> <b>源代码</b> 或 <a href='https://github.com/LiteyukiStudio/nonebot-plugin-marshoai/tree/main/nonebot_plugin_marshoai/models.py#L116' target='_blank'>在GitHub上查看</a></summary>

```python
async def call(self, full_function_name: str, args: dict):
    parts = full_function_name.split('__')
    if len(parts) == 2:
        package_name = parts[0]
        function_name = parts[1]
    else:
        logger.error('函数名无效')
    if package_name in self.imported_packages:
        package = self.imported_packages[package_name]
        try:
            function = getattr(package, function_name)
            return await function(**args)
        except Exception as e:
            errinfo = f"调用函数 '{function_name}'时发生错误:{e}"
            logger.error(errinfo)
            return errinfo
    else:
        logger.error(f"工具包 '{package_name}' 未导入")
```
</details>

---
#### ***func*** `get_tools_list(self)`


<details>
<summary> <b>源代码</b> 或 <a href='https://github.com/LiteyukiStudio/nonebot-plugin-marshoai/tree/main/nonebot_plugin_marshoai/models.py#L139' target='_blank'>在GitHub上查看</a></summary>

```python
def get_tools_list(self):
    if not self.tools_list or not config.marshoai_enable_tools:
        return None
    return self.tools_list
```
</details>