📝 Docs: 升级新版 NonePress 主题 (#2375)

nonebot/internal/driver/__init__.py

@@ -1,30 +1,30 @@
 from .model import URL as URL
-from .driver import Mixin as Mixin
 from .model import RawURL as RawURL
-from .driver import Driver as Driver
+from .abstract import Mixin as Mixin
 from .model import Cookies as Cookies
 from .model import Request as Request
+from .abstract import Driver as Driver
 from .model import FileType as FileType
 from .model import Response as Response
 from .model import DataTypes as DataTypes
 from .model import FileTypes as FileTypes
 from .model import WebSocket as WebSocket
-from .driver import ASGIMixin as ASGIMixin
 from .model import FilesTypes as FilesTypes
 from .model import QueryTypes as QueryTypes
+from .abstract import ASGIMixin as ASGIMixin
 from .model import CookieTypes as CookieTypes
 from .model import FileContent as FileContent
 from .model import HTTPVersion as HTTPVersion
 from .model import HeaderTypes as HeaderTypes
 from .model import SimpleQuery as SimpleQuery
 from .model import ContentTypes as ContentTypes
-from .driver import ForwardMixin as ForwardMixin
-from .driver import ReverseMixin as ReverseMixin
 from .model import QueryVariable as QueryVariable
-from .driver import ForwardDriver as ForwardDriver
-from .driver import ReverseDriver as ReverseDriver
-from .driver import combine_driver as combine_driver
+from .abstract import ForwardMixin as ForwardMixin
+from .abstract import ReverseMixin as ReverseMixin
+from .abstract import ForwardDriver as ForwardDriver
+from .abstract import ReverseDriver as ReverseDriver
+from .combine import combine_driver as combine_driver
 from .model import HTTPServerSetup as HTTPServerSetup
-from .driver import HTTPClientMixin as HTTPClientMixin
+from .abstract import HTTPClientMixin as HTTPClientMixin
 from .model import WebSocketServerSetup as WebSocketServerSetup
-from .driver import WebSocketClientMixin as WebSocketClientMixin
+from .abstract import WebSocketClientMixin as WebSocketClientMixin

nonebot/internal/driver/abstract.py

@@ -2,18 +2,7 @@ import abc
 import asyncio
 from typing_extensions import TypeAlias
 from contextlib import AsyncExitStack, asynccontextmanager
-from typing import (
-    TYPE_CHECKING,
-    Any,
-    Set,
-    Dict,
-    Type,
-    Union,
-    TypeVar,
-    Callable,
-    AsyncGenerator,
-    overload,
-)
+from typing import TYPE_CHECKING, Any, Set, Dict, Type, Callable, AsyncGenerator
 
 from nonebot.log import logger
 from nonebot.config import Env, Config
@@ -33,8 +22,6 @@ if TYPE_CHECKING:
     from nonebot.internal.adapter import Bot, Adapter
 
 
-D = TypeVar("D", bound="Driver")
-
 BOT_HOOK_PARAMS = [DependParam, BotParam, DefaultParam]
 
 
@@ -295,44 +282,3 @@ ReverseDriver: TypeAlias = ReverseMixin
 
 **Deprecated**，请使用 {ref}`nonebot.drivers.ReverseMixin` 或其子类代替。
 """
-
-
-if TYPE_CHECKING:
-
-    class CombinedDriver(Driver, Mixin):
-        ...
-
-
-@overload
-def combine_driver(driver: Type[D]) -> Type[D]:
-    ...
-
-
-@overload
-def combine_driver(driver: Type[D], *mixins: Type[Mixin]) -> Type["CombinedDriver"]:
-    ...
-
-
-def combine_driver(
-    driver: Type[D], *mixins: Type[Mixin]
-) -> Union[Type[D], Type["CombinedDriver"]]:
-    """将一个驱动器和多个混入类合并。"""
-    # check first
-    assert issubclass(driver, Driver), "`driver` must be subclass of Driver"
-    assert all(
-        issubclass(m, Mixin) for m in mixins
-    ), "`mixins` must be subclass of Mixin"
-
-    if not mixins:
-        return driver
-
-    def type_(self: "CombinedDriver") -> str:
-        return (
-            driver.type.__get__(self)
-            + "+"
-            + "+".join(x.type.__get__(self) for x in mixins)
-        )
-
-    return type(
-        "CombinedDriver", (*mixins, driver), {"type": property(type_)}
-    )  # type: ignore

nonebot/internal/driver/combine.py

@@ -0,0 +1,45 @@
+from typing import TYPE_CHECKING, Type, Union, TypeVar, overload
+
+from .abstract import Mixin, Driver
+
+D = TypeVar("D", bound="Driver")
+
+if TYPE_CHECKING:
+
+    class CombinedDriver(Driver, Mixin):
+        ...
+
+
+@overload
+def combine_driver(driver: Type[D]) -> Type[D]:
+    ...
+
+
+@overload
+def combine_driver(driver: Type[D], *mixins: Type[Mixin]) -> Type["CombinedDriver"]:
+    ...
+
+
+def combine_driver(
+    driver: Type[D], *mixins: Type[Mixin]
+) -> Union[Type[D], Type["CombinedDriver"]]:
+    """将一个驱动器和多个混入类合并。"""
+    # check first
+    if not issubclass(driver, Driver):
+        raise TypeError("`driver` must be subclass of Driver")
+    if not all(issubclass(m, Mixin) for m in mixins):
+        raise TypeError("`mixins` must be subclass of Mixin")
+
+    if not mixins:
+        return driver
+
+    def type_(self: "CombinedDriver") -> str:
+        return (
+            driver.type.__get__(self)
+            + "+"
+            + "+".join(x.type.__get__(self) for x in mixins)
+        )
+
+    return type(
+        "CombinedDriver", (*mixins, driver), {"type": property(type_)}
+    )  # type: ignore

nonebot/plugin/__init__.py

@@ -29,7 +29,7 @@
 - `load_builtin_plugins` =>
   {ref}``load_builtin_plugins` <nonebot.plugin.load.load_builtin_plugins>`
 - `require` => {ref}``require` <nonebot.plugin.load.require>`
-- `PluginMetadata` => {ref}``PluginMetadata` <nonebot.plugin.plugin.PluginMetadata>`
+- `PluginMetadata` => {ref}``PluginMetadata` <nonebot.plugin.model.PluginMetadata>`
 
 FrontMatter:
     sidebar_position: 0
@@ -77,7 +77,7 @@ def get_plugin(name: str) -> Optional["Plugin"]:
     如果为 `load_plugins` 文件夹导入的插件，则为文件(夹)名。
 
     参数:
-        name: 插件名，即 {ref}`nonebot.plugin.plugin.Plugin.name`。
+        name: 插件名，即 {ref}`nonebot.plugin.model.Plugin.name`。
     """
     return _plugins.get(name)
 
@@ -88,7 +88,7 @@ def get_plugin_by_module_name(module_name: str) -> Optional["Plugin"]:
     如果提供的模块名为某个插件的子模块，同样会返回该插件。
 
     参数:
-        module_name: 模块名，即 {ref}`nonebot.plugin.plugin.Plugin.module_name`。
+        module_name: 模块名，即 {ref}`nonebot.plugin.model.Plugin.module_name`。
     """
     loaded = {plugin.module_name: plugin for plugin in _plugins.values()}
     has_parent = True
@@ -111,9 +111,9 @@ def get_available_plugin_names() -> Set[str]:
 from .on import on as on
 from .manager import PluginManager
 from .on import on_type as on_type
+from .model import Plugin as Plugin
 from .load import require as require
 from .on import on_regex as on_regex
-from .plugin import Plugin as Plugin
 from .on import on_notice as on_notice
 from .on import on_command as on_command
 from .on import on_keyword as on_keyword
@@ -129,8 +129,8 @@ from .load import load_plugins as load_plugins
 from .on import on_startswith as on_startswith
 from .load import load_from_json as load_from_json
 from .load import load_from_toml as load_from_toml
+from .model import PluginMetadata as PluginMetadata
 from .on import on_shell_command as on_shell_command
-from .plugin import PluginMetadata as PluginMetadata
 from .load import load_all_plugins as load_all_plugins
 from .load import load_builtin_plugin as load_builtin_plugin
 from .load import load_builtin_plugins as load_builtin_plugins

nonebot/plugin/load.py

@@ -12,7 +12,7 @@ from typing import Set, Union, Iterable, Optional
 
 from nonebot.utils import path_to_module_name
 
-from .plugin import Plugin
+from .model import Plugin
 from .manager import PluginManager
 from . import _managers, get_plugin, _current_plugin_chain, _module_name_to_plugin_name
 
@@ -160,7 +160,7 @@ def require(name: str) -> ModuleType:
     如果为 `load_plugins` 文件夹导入的插件，则为文件(夹)名。
 
     参数:
-        name: 插件名，即 {ref}`nonebot.plugin.plugin.Plugin.name`。
+        name: 插件名，即 {ref}`nonebot.plugin.model.Plugin.name`。
 
     异常:
         RuntimeError: 插件无法加载

nonebot/plugin/manager.py

@@ -20,7 +20,7 @@ from typing import Set, Dict, List, Iterable, Optional, Sequence
 from nonebot.log import logger
 from nonebot.utils import escape_tag, path_to_module_name
 
-from .plugin import Plugin, PluginMetadata
+from .model import Plugin, PluginMetadata
 from . import (
     _managers,
     _new_plugin,

nonebot/plugin/model.py

@@ -2,7 +2,7 @@
 
 FrontMatter:
     sidebar_position: 3
-    description: nonebot.plugin.plugin 模块
+    description: nonebot.plugin.model 模块
 """
 
 import contextlib

nonebot/plugin/on.py

@@ -30,7 +30,7 @@ from nonebot.rule import (
     shell_command,
 )
 
-from .plugin import Plugin
+from .model import Plugin
 from . import get_plugin_by_module_name
 from .manager import _current_plugin_chain
 

nonebot/plugin/on.pyi

@@ -10,7 +10,7 @@ from nonebot.rule import Rule, ArgumentParser
 from nonebot.matcher import Matcher, MatcherSource
 from nonebot.typing import T_State, T_Handler, T_RuleChecker, T_PermissionChecker
 
-from .plugin import Plugin
+from .model import Plugin
 
 def store_matcher(matcher: type[Matcher]) -> None: ...
 def get_matcher_plugin(depth: int = ...) -> Plugin | None: ...

nonebot/rule.py

@@ -599,7 +599,7 @@ def shell_command(
     通过 {ref}`nonebot.params.ShellCommandArgs` 获取解析后的参数字典
     （例: `{"arg": "arg", "h": True}`）。
 
-    :::warning 警告
+    :::caution 警告
     如果参数解析失败，则通过 {ref}`nonebot.params.ShellCommandArgs`
     获取的将是 {ref}`nonebot.exception.ParserExit` 异常。
     :::