✨ Feature: 添加插件 Pydantic 相关使用方法 (#2563)

nonebot/__init__.py

@@ -35,6 +35,7 @@
   {ref}``get_loaded_plugins` <nonebot.plugin.get_loaded_plugins>`
 - `get_available_plugin_names` =>
   {ref}``get_available_plugin_names` <nonebot.plugin.get_available_plugin_names>`
+- `get_plugin_config` => {ref}``get_plugin_config` <nonebot.plugin.get_plugin_config>`
 - `require` => {ref}``require` <nonebot.plugin.load.require>`
 
 FrontMatter:
@@ -352,6 +353,7 @@ from nonebot.plugin import load_from_json as load_from_json
 from nonebot.plugin import load_from_toml as load_from_toml
 from nonebot.plugin import load_all_plugins as load_all_plugins
 from nonebot.plugin import on_shell_command as on_shell_command
+from nonebot.plugin import get_plugin_config as get_plugin_config
 from nonebot.plugin import get_loaded_plugins as get_loaded_plugins
 from nonebot.plugin import load_builtin_plugin as load_builtin_plugin
 from nonebot.plugin import load_builtin_plugins as load_builtin_plugins

nonebot/compat.py

@@ -12,6 +12,7 @@ from typing_extensions import Self, Annotated, is_typeddict
 from typing import (
     TYPE_CHECKING,
     Any,
+    Set,
     Dict,
     List,
     Type,
@@ -50,6 +51,7 @@ __all__ = (
     "model_field_validate",
     "model_fields",
     "model_config",
+    "model_dump",
     "type_validate_python",
     "custom_validation",
 )
@@ -183,6 +185,13 @@ if PYDANTIC_V2:  # pragma: pydantic-v2
         """Get config of a model."""
         return model.model_config
 
+    def model_dump(
+        model: BaseModel,
+        include: Optional[Set[str]] = None,
+        exclude: Optional[Set[str]] = None,
+    ) -> Dict[str, Any]:
+        return model.model_dump(include=include, exclude=exclude)
+
     def type_validate_python(type_: Type[T], data: Any) -> T:
         """Validate data with given type."""
         return TypeAdapter(type_).validate_python(data)
@@ -321,6 +330,13 @@ else:  # pragma: pydantic-v1
         """Get config of a model."""
         return model.__config__
 
+    def model_dump(
+        model: BaseModel,
+        include: Optional[Set[str]] = None,
+        exclude: Optional[Set[str]] = None,
+    ) -> Dict[str, Any]:
+        return model.dict(include=include, exclude=exclude)
+
     def type_validate_python(type_: Type[T], data: Any) -> T:
         """Validate data with given type."""
         return parse_obj_as(type_, data)

nonebot/plugin/__init__.py

@@ -39,7 +39,14 @@ FrontMatter:
 from itertools import chain
 from types import ModuleType
 from contextvars import ContextVar
-from typing import Set, Dict, List, Tuple, Optional
+from typing import Set, Dict, List, Type, Tuple, TypeVar, Optional
+
+from pydantic import BaseModel
+
+from nonebot import get_driver
+from nonebot.compat import model_dump, type_validate_python
+
+C = TypeVar("C", bound=BaseModel)
 
 _plugins: Dict[str, "Plugin"] = {}
 _managers: List["PluginManager"] = []
@@ -108,6 +115,11 @@ def get_available_plugin_names() -> Set[str]:
     return {*chain.from_iterable(manager.available_plugins for manager in _managers)}
 
 
+def get_plugin_config(config: Type[C]) -> C:
+    """从全局配置获取当前插件需要的配置项。"""
+    return type_validate_python(config, model_dump(get_driver().config))
+
+
 from .on import on as on
 from .manager import PluginManager
 from .on import on_type as on_type