nonebot-plugin-htmlrender 0.6.2__tar.gz → 0.6.5__tar.gz

{nonebot_plugin_htmlrender-0.6.2 → nonebot_plugin_htmlrender-0.6.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nonebot-plugin-htmlrender
-Version: 0.6.2
+Version: 0.6.5
 Summary: 通过浏览器渲染图片
 Project-URL: Homepage, https://github.com/kexue-z/nonebot-plugin-htmlrender
 Project-URL: Bug Tracker, https://github.com/kexue-z/nonebot-plugin-htmlrender/issues
@@ -31,7 +31,7 @@ Requires-Python: <4.0,>=3.9
 Requires-Dist: aiofiles>=0.8.0
 Requires-Dist: jinja2>=3.0.3
 Requires-Dist: markdown>=3.3.6
-Requires-Dist: nonebot2>=2.2.0
+Requires-Dist: nonebot2>=2.4.2
 Requires-Dist: playwright>=1.48.0
 Requires-Dist: pygments>=2.10.0
 Requires-Dist: pymdown-extensions>=9.1

{nonebot_plugin_htmlrender-0.6.2 → nonebot_plugin_htmlrender-0.6.5}/nonebot_plugin_htmlrender/browser.py

@@ -13,7 +13,7 @@ from playwright.async_api import (
 
 from nonebot_plugin_htmlrender.config import plugin_config
 from nonebot_plugin_htmlrender.install import install_browser
-from nonebot_plugin_htmlrender.utils import proxy_settings, suppress_and_log
+from nonebot_plugin_htmlrender.utils import proxy_settings, suppress_and_log, with_lock
 
 _browser: Optional[Browser] = None
 _playwright: Optional[Playwright] = None
@@ -53,8 +53,6 @@ async def init_browser(**kwargs) -> Browser:
     Raises:
         RuntimeError: 如果浏览器无法启动或安装失败。
     """
-    await install_browser()  # update playwright when start
-    await check_playwright_env()
     return await start_browser(**kwargs)
 
 
@@ -72,12 +70,11 @@ async def get_new_page(device_scale_factor: float = 2, **kwargs) -> AsyncIterato
     """
     ctx = await get_browser()
     page = await ctx.new_page(device_scale_factor=device_scale_factor, **kwargs)
-    try:
+    async with page:
         yield page
-    finally:
-        await page.close()
 
 
+@with_lock
 async def get_browser(**kwargs) -> Browser:
     """
     获取浏览器实例。
@@ -117,6 +114,32 @@ async def _connect_via_cdp(**kwargs) -> Browser:
         raise RuntimeError("Playwright 未初始化")
 
 
+async def _connect(browser_type: str, **kwargs) -> Browser:
+    """
+    通过 Playwright 协议连接浏览器。
+
+    Args:
+        browser_type (str): 浏览器类型。
+        **kwargs: 传递给`playwright.connect`的关键字参数。
+
+    Returns:
+        Browser: 启动的浏览器实例。
+
+    Raises:
+        RuntimeError: 如果 Playwright 未初始化。
+    """
+    _browser_cls: BrowserType = getattr(_playwright, browser_type)
+    kwargs["ws_endpoint"] = plugin_config.htmlrender_connect
+    logger.info(
+        f"正在使用 Playwright 协议连接 {browser_type}({plugin_config.htmlrender_connect})"
+    )
+    if _playwright is not None:
+        return await _browser_cls.connect(**kwargs)
+    else:
+        raise RuntimeError("Playwright 未初始化")
+
+
+@with_lock
 async def start_browser(**kwargs) -> Browser:
     """
     启动 Playwright 浏览器实例。
@@ -128,24 +151,35 @@ async def start_browser(**kwargs) -> Browser:
         Browser: 启动的浏览器实例。
     """
     global _browser, _playwright
+
+    await shutdown_browser()
     _playwright = await async_playwright().start()
 
     if (
         plugin_config.htmlrender_browser == "chromium"
         and plugin_config.htmlrender_connect_over_cdp
     ):
-        return await _connect_via_cdp(**kwargs)
+        _browser = await _connect_via_cdp(**kwargs)
+    elif plugin_config.htmlrender_connect:
+        _browser = await _connect(plugin_config.htmlrender_browser, **kwargs)
+    else:
+        if plugin_config.htmlrender_browser_channel:
+            kwargs["channel"] = plugin_config.htmlrender_browser_channel
 
-    if plugin_config.htmlrender_browser_channel:
-        kwargs["channel"] = plugin_config.htmlrender_browser_channel
+        if plugin_config.htmlrender_proxy_host:
+            kwargs["proxy"] = proxy_settings(plugin_config.htmlrender_proxy_host)
 
-    if plugin_config.htmlrender_proxy_host:
-        kwargs["proxy"] = proxy_settings(plugin_config.htmlrender_proxy_host)
+        if plugin_config.htmlrender_browser_executable_path:
+            kwargs["executable_path"] = plugin_config.htmlrender_browser_executable_path
+        else:
+            try:
+                await check_playwright_env()
+            except RuntimeError:
+                await install_browser()
+                await check_playwright_env()
 
-    if plugin_config.htmlrender_browser_executable_path:
-        kwargs["executable_path"] = plugin_config.htmlrender_browser_executable_path
+        _browser = await _launch(plugin_config.htmlrender_browser, **kwargs)
 
-    _browser = await _launch(plugin_config.htmlrender_browser, **kwargs)
     return _browser
 
 
@@ -164,7 +198,7 @@ async def check_playwright_env():
     logger.info("Checking Playwright environment...")
     try:
         async with async_playwright() as p:
-            await p.chromium.launch()
+            await getattr(p, plugin_config.htmlrender_browser).launch()
     except Exception as e:
         raise RuntimeError(
             "Playwright environment is not set up correctly. "

{nonebot_plugin_htmlrender-0.6.2 → nonebot_plugin_htmlrender-0.6.5}/nonebot_plugin_htmlrender/config.py

@@ -1,10 +1,9 @@
-from typing import Optional
-from typing_extensions import Self
+from typing import Any, Optional
 
 from nonebot import get_driver, get_plugin_config
+from nonebot.compat import model_validator
 from pydantic import BaseModel, Field
 
-from nonebot_plugin_htmlrender.compat import model_validator
 from nonebot_plugin_htmlrender.consts import BROWSER_CHANNEL_TYPES, BROWSER_ENGINE_TYPES
 
 
@@ -36,25 +35,39 @@ class Config(BaseModel):
     htmlrender_connect_over_cdp: Optional[str] = Field(
         default=None, description="通过 CDP 连接Playwright浏览器的端点地址。"
     )
+    htmlrender_connect: Optional[str] = Field(
+        default=None, description="通过Playwright协议连接Playwright浏览器的端点地址。"
+    )
 
     @model_validator(mode="after")
-    def check_browser_channel(self) -> Self:
-        if (
-            self.htmlrender_browser_channel is not None
-            and self.htmlrender_browser_channel not in BROWSER_CHANNEL_TYPES
-        ):
+    @classmethod
+    def check_browser_channel(cls, data: Any) -> Any:
+        browser_channel = (
+            data.get("htmlrender_browser_channel")
+            if isinstance(data, dict)
+            else getattr(data, "htmlrender_browser_channel", None)
+        )
+
+        if browser_channel is not None and browser_channel not in BROWSER_CHANNEL_TYPES:
             raise ValueError(
                 f"Invalid browser channel type. Must be one of {BROWSER_CHANNEL_TYPES}"
             )
-        return self
+        return data
 
     @model_validator(mode="after")
-    def check_browser(self) -> Self:
-        if self.htmlrender_browser not in BROWSER_ENGINE_TYPES:
+    @classmethod
+    def check_browser(cls, data: Any) -> Any:
+        browser = (
+            data.get("htmlrender_browser", "chromium")
+            if isinstance(data, dict)
+            else getattr(data, "htmlrender_browser", "chromium")
+        )
+
+        if browser not in BROWSER_ENGINE_TYPES:
             raise ValueError(
                 f"Invalid browser type. Must be one of {BROWSER_ENGINE_TYPES}"
             )
-        return self
+        return data
 
 
 global_config = get_driver().config

{nonebot_plugin_htmlrender-0.6.2 → nonebot_plugin_htmlrender-0.6.5}/nonebot_plugin_htmlrender/utils.py

@@ -1,3 +1,5 @@
+from asyncio import Lock
+from collections.abc import Awaitable
 from contextlib import contextmanager
 from functools import wraps
 import re
@@ -146,3 +148,14 @@ def proxy_settings(proxy_host: Optional[str]) -> Optional[dict]:
         proxy["bypass"] = plugin_config.htmlrender_proxy_host_bypass
 
     return proxy
+
+
+def with_lock(func: Callable[P, Awaitable[R]]) -> Callable[P, Awaitable[R]]:
+    lock = Lock()
+
+    @wraps(func)
+    async def wrapper(*args, **kwargs) -> R:
+        async with lock:
+            return await func(*args, **kwargs)
+
+    return wrapper

{nonebot_plugin_htmlrender-0.6.2 → nonebot_plugin_htmlrender-0.6.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "nonebot-plugin-htmlrender"
-version = "0.6.2"
+version = "0.6.5"
 description = "通过浏览器渲染图片"
 readme = "README.md"
 authors = [{ name = "kexue", email = "x@kexue-cloud.cn" }]
@@ -10,7 +10,7 @@ dependencies = [
     "aiofiles>=0.8.0",
     "jinja2>=3.0.3",
     "markdown>=3.3.6",
-    "nonebot2>=2.2.0",
+    "nonebot2>=2.4.2",
     "playwright>=1.48.0",
     "pygments>=2.10.0",
     "pymdown-extensions>=9.1",

{nonebot_plugin_htmlrender-0.6.2 → nonebot_plugin_htmlrender-0.6.5}/tests/test_browser.py

@@ -39,6 +39,7 @@ def browser_config() -> dict[str, str]:
     return {
         "browser": "chromium",
         "cdp": "ws://localhost:9222",
+        "pwp": "ws://localhost:3000/chromium/playwright",
     }
 
 
@@ -169,6 +170,29 @@ async def test_connect_via_cdp(
     assert browser == mock_browser
 
 
+@pytest.mark.asyncio
+async def test_connect(
+    mocker: MockerFixture, mock_browser: Browser, browser_config: dict[str, str]
+) -> None:
+    """测试通过Playwright协议连接浏览器"""
+    from nonebot_plugin_htmlrender.browser import start_browser
+
+    mocker.patch(
+        "nonebot_plugin_htmlrender.browser._connect", return_value=mock_browser
+    )
+    mocker.patch(
+        "nonebot_plugin_htmlrender.browser.plugin_config.htmlrender_browser",
+        browser_config["browser"],
+    )
+    mocker.patch(
+        "nonebot_plugin_htmlrender.browser.plugin_config.htmlrender_connect",
+        browser_config["pwp"],
+    )
+
+    browser = await start_browser()
+    assert browser == mock_browser
+
+
 @pytest.mark.parametrize(
     ("proxy_url", "expected"),
     [