nonebot-plugin-htmlrender 0.6.0b1__tar.gz → 0.6.2__tar.gz

{nonebot_plugin_htmlrender-0.6.0b1 → nonebot_plugin_htmlrender-0.6.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nonebot-plugin-htmlrender
-Version: 0.6.0b1
+Version: 0.6.2
 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

{nonebot_plugin_htmlrender-0.6.0b1 → nonebot_plugin_htmlrender-0.6.2}/nonebot_plugin_htmlrender/__init__.py

@@ -30,16 +30,16 @@ driver = nonebot.get_driver()
 
 @driver.on_startup
 async def init(**kwargs):
-    logger.info("htmlrender启动中...")
+    logger.info("HTMLRender Starting...")
     await init_browser(**kwargs)
-    logger.info("htmlrender已启动.")
+    logger.info("HTMLRender Started.")
 
 
 @driver.on_shutdown
 async def shutdown():
-    logger.info("htmlrender关闭中...")
+    logger.info("HTMLRender Shutting down...")
     await shutdown_browser()
-    logger.info("htmlrender已关闭.")
+    logger.info("HTMLRender Shut down.")
 
 
 __all__ = [

{nonebot_plugin_htmlrender-0.6.0b1 → nonebot_plugin_htmlrender-0.6.2}/nonebot_plugin_htmlrender/browser.py

@@ -6,13 +6,12 @@ from nonebot.log import logger
 from playwright.async_api import (
     Browser,
     BrowserType,
-    Error,
     Page,
     Playwright,
     async_playwright,
 )
 
-from nonebot_plugin_htmlrender.config import BrowserEngineType, plugin_config
+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
 
@@ -20,12 +19,12 @@ _browser: Optional[Browser] = None
 _playwright: Optional[Playwright] = None
 
 
-async def _launch(browser_type: BrowserEngineType, **kwargs) -> Browser:
+async def _launch(browser_type: str, **kwargs) -> Browser:
     """
     启动浏览器实例。
 
     Args:
-        browser_type (BrowserEngineType): 浏览器类型。
+        browser_type (str): 浏览器类型。
         **kwargs: 传递给`playwright.launch`的关键字参数。
 
     Returns:
@@ -54,24 +53,15 @@ async def init_browser(**kwargs) -> Browser:
     Raises:
         RuntimeError: 如果浏览器无法启动或安装失败。
     """
-    try:
-        return await start_browser(**kwargs)
-    except (Error, Exception) as e:
-        if "Executable doesn't exist" not in str(e):
-            raise RuntimeError("无法启动浏览器实例") from e
-        try:
-            if await install_browser():
-                return await start_browser(**kwargs)
-            else:
-                raise RuntimeError("无法启动浏览器实例且尝试安装失败") from e
-        except Exception as e:
-            raise RuntimeError("无法启动浏览器实例") from e
+    await install_browser()  # update playwright when start
+    await check_playwright_env()
+    return await start_browser(**kwargs)
 
 
 @asynccontextmanager
 async def get_new_page(device_scale_factor: float = 2, **kwargs) -> AsyncIterator[Page]:
     """
-    获取一个新的页面的上下文管理器。
+    获取一个新的页面的上下文管理器, 这里的 page 默认使用设备缩放因子为 2。
 
     Args:
         device_scale_factor (float): 设备缩放因子。
@@ -167,3 +157,16 @@ async def shutdown_browser() -> None:
     if _playwright:
         with suppress_and_log():
             await _playwright.stop()
+
+
+async def check_playwright_env():
+    """Check Playwright environment."""
+    logger.info("Checking Playwright environment...")
+    try:
+        async with async_playwright() as p:
+            await p.chromium.launch()
+    except Exception as e:
+        raise RuntimeError(
+            "Playwright environment is not set up correctly. "
+            "Refer to https://playwright.dev/python/docs/intro#system-requirements"
+        ) from e

nonebot_plugin_htmlrender-0.6.2/nonebot_plugin_htmlrender/compat.py

@@ -0,0 +1,24 @@
+from typing import Literal, overload
+
+from nonebot.compat import PYDANTIC_V2
+
+__all__ = ("model_validator",)
+
+# todo)) 等nb更新切换到nb提供的兼容层
+if PYDANTIC_V2:
+    from pydantic import field_validator as field_validator
+    from pydantic import model_validator as model_validator
+else:
+    from pydantic import root_validator, validator
+
+    @overload
+    def model_validator(*, mode: Literal["before"]): ...
+
+    @overload
+    def model_validator(*, mode: Literal["after"]): ...
+
+    def model_validator(*, mode: Literal["before", "after"] = "after"):
+        return root_validator(pre=mode == "before", allow_reuse=True)
+
+    def field_validator(__field, *fields, mode: Literal["before", "after"] = "after"):  # noqa: PYI063
+        return validator(__field, *fields, pre=mode == "before", allow_reuse=True)

{nonebot_plugin_htmlrender-0.6.0b1 → nonebot_plugin_htmlrender-0.6.2}/nonebot_plugin_htmlrender/config.py

@@ -1,55 +1,17 @@
-from collections.abc import Generator
-from typing import Any, Callable, ClassVar, Optional
+from typing import Optional
+from typing_extensions import Self
 
 from nonebot import get_driver, get_plugin_config
-from nonebot.compat import custom_validation
 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
 
 
-@custom_validation
-class BrowserEngineType(str):
-    """Playwright浏览器引擎类型，支持的值由 BROWSER_ENGINE_TYPES 定义。"""
-
-    ALLOWED_VALUES: ClassVar = BROWSER_ENGINE_TYPES
-
-    @classmethod
-    def __get_validators__(cls) -> Generator[Callable[..., Any], None, None]:
-        yield cls.validate
-
-    @classmethod
-    def validate(cls, value: Any) -> str:
-        if value not in cls.ALLOWED_VALUES:
-            raise ValueError(
-                f"Invalid browser type: {value!r}, must be one of {cls.ALLOWED_VALUES}"
-            )
-        return value
-
-
-@custom_validation
-class BrowserChannelType(str):
-    """Playwright浏览器通道类型，支持的值由 BROWSER_CHANNEL_TYPES 定义。"""
-
-    ALLOWED_VALUES: ClassVar = BROWSER_CHANNEL_TYPES
-
-    @classmethod
-    def __get_validators__(cls) -> Generator[Callable[..., Any], None, None]:
-        yield cls.validate
-
-    @classmethod
-    def validate(cls, value: Any) -> str:
-        if value not in cls.ALLOWED_VALUES:
-            raise ValueError(
-                f"Invalid channel: {value!r}, must be one of {cls.ALLOWED_VALUES}"
-            )
-        return value
-
-
 class Config(BaseModel):
     """插件配置类。"""
 
-    htmlrender_browser: BrowserEngineType = Field(
+    htmlrender_browser: str = Field(
         default="chromium",
         description="Playwright浏览器引擎类型，默认值为 'chromium'。",
     )
@@ -65,7 +27,7 @@ class Config(BaseModel):
     htmlrender_proxy_host_bypass: Optional[str] = Field(
         default=None, description="Playwright浏览器代理的绕过地址。"
     )
-    htmlrender_browser_channel: Optional[BrowserChannelType] = Field(
+    htmlrender_browser_channel: Optional[str] = Field(
         default=None, description="Playwright浏览器通道类型。"
     )
     htmlrender_browser_executable_path: Optional[str] = Field(
@@ -75,6 +37,25 @@ class Config(BaseModel):
         default=None, description="通过 CDP 连接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
+        ):
+            raise ValueError(
+                f"Invalid browser channel type. Must be one of {BROWSER_CHANNEL_TYPES}"
+            )
+        return self
+
+    @model_validator(mode="after")
+    def check_browser(self) -> Self:
+        if self.htmlrender_browser not in BROWSER_ENGINE_TYPES:
+            raise ValueError(
+                f"Invalid browser type. Must be one of {BROWSER_ENGINE_TYPES}"
+            )
+        return self
+
 
 global_config = get_driver().config
 plugin_config = get_plugin_config(Config)

{nonebot_plugin_htmlrender-0.6.0b1 → nonebot_plugin_htmlrender-0.6.2}/nonebot_plugin_htmlrender/consts.py

@@ -19,8 +19,8 @@ WINDOWS = sys.platform.startswith("win") or (sys.platform == "cli" and os.name =
 # MINGW = sysconfig.get_platform().startswith("mingw")
 # MACOS = sys.platform == "darwin"
 MIRRORS = [
-    MirrorSource("官方", "https://playwright.azureedge.net", 1),
-    MirrorSource("淘宝", "https://registry.npmmirror.com/-/binary/playwright", 2),
+    MirrorSource("Default", "https://playwright.azureedge.net", 1),
+    MirrorSource("Taobao", "https://registry.npmmirror.com/-/binary/playwright", 2),
 ]
 BROWSER_ENGINE_TYPES = ["chromium", "firefox", "webkit"]
 BROWSER_CHANNEL_TYPES = [

{nonebot_plugin_htmlrender-0.6.0b1 → nonebot_plugin_htmlrender-0.6.2}/nonebot_plugin_htmlrender/data_source.py

@@ -284,17 +284,32 @@ async def template_to_pic(
 async def capture_element(
     url: str,
     element: str,
-    timeout: float = 0,
-    type: Literal["jpeg", "png"] = "png",
-    quality: Union[int, None] = None,
-    screenshot_timeout: Optional[float] = 30_000,
-    **kwargs,
+    page_kwargs: Optional[dict] = None,
+    goto_kwargs: Optional[dict] = None,
+    screenshot_kwargs: Optional[dict] = None,
 ) -> bytes:
-    async with get_new_page(**kwargs) as page:
-        page.on("console", lambda msg: logger.debug(f"浏览器控制台: {msg.text}"))
-        await page.goto(url, timeout=timeout)
-        return await page.locator(element).screenshot(
-            type=type,
-            quality=quality,
-            timeout=screenshot_timeout,
+    """捕获网页中指定元素的截图, 通过CSS选择器或XPath表达式指定元素。
+
+    Args:
+        url: 目标网页URL
+        element: CSS选择器或XPath表达式
+        page_kwargs: 传递给get_new_page的参数
+        goto_kwargs: 传递给page.goto方法的额外参数
+        screenshot_kwargs: 传递给screenshot方法的额外参数
+
+    Returns:
+        bytes: 元素截图数据
+    """
+    page_kwargs = page_kwargs or {}
+    goto_kwargs = goto_kwargs or {}
+    screenshot_kwargs = screenshot_kwargs or {}
+
+    async with get_new_page(**page_kwargs) as page:
+        page.on(
+            "console",
+            lambda msg: logger.opt(colors=True).debug(
+                f"<cyan>[Browser Console]</cyan> {msg.text}"
+            ),
         )
+        await page.goto(url, **goto_kwargs)
+        return await page.locator(element).screenshot(**screenshot_kwargs)

{nonebot_plugin_htmlrender-0.6.0b1 → nonebot_plugin_htmlrender-0.6.2}/nonebot_plugin_htmlrender/install.py

@@ -77,19 +77,19 @@ async def download_context() -> AsyncIterator[None]:
     if plugin_config.htmlrender_download_proxy:
         proxy = plugin_config.htmlrender_download_proxy
         if proxy.startswith("http://") and not os.environ.get("HTTP_PROXY"):
-            logger.info(f"已设置 HTTP 代理: {proxy}")
+            logger.info(f"Using http Proxy: {proxy}")
             os.environ["HTTP_PROXY"] = proxy
         elif proxy.startswith("https://") and not os.environ.get("HTTPS_PROXY"):
-            logger.info(f"已设置 HTTPS 代理: {proxy}")
+            logger.info(f"Using https Proxy: {proxy}")
             os.environ["HTTPS_PROXY"] = proxy
 
     try:
         best_mirror = await check_mirror_connectivity()
         if best_mirror is not None:
-            logger.info(f"使用镜像源: {best_mirror.name} ({best_mirror.url})")
+            logger.info(f"Using Mirror source: {best_mirror.name} ({best_mirror.url})")
             os.environ["PLAYWRIGHT_DOWNLOAD_HOST"] = best_mirror.url
         else:
-            logger.info("未找到可用的镜像源，将使用官方源")
+            logger.info("Mirror source not available, using default")
 
         yield
 
@@ -143,7 +143,7 @@ async def read_stream(
             if "|" in text and "%" in text:
                 if text != last_progress:
                     if callback:
-                        await callback(f"下载进度: {text}")
+                        await callback(f"Progress: {text}")
                     last_progress = text
             else:
                 if callback:
@@ -153,7 +153,7 @@ async def read_stream(
         except asyncio.IncompleteReadError:
             break
         except Exception as e:
-            logger.opt(exception=True).error(f"读取流时发生错误: {e!s}")
+            logger.opt(exception=True).error(f"Error reading stream: {e!s}")
             break
 
     return "\n".join(output)
@@ -196,18 +196,18 @@ async def execute_install_command(timeout: int) -> tuple[bool, str]:
             )
         except asyncio.TimeoutError:
             await terminate_process(process)
-            return False, f"安装超时 ({timeout}s)"
+            return False, f"Timed out ({timeout}s)"
 
         await process.wait()
         returncode = process.returncode
 
         if returncode != 0:
-            return False, f"安装失败 (exit code: {returncode})"
+            return False, f"Exited with code {returncode}"
 
-        return True, "安装完成"
+        return True, "Installation completed"
 
     except Exception as e:
-        return False, f"安装失败: {e!s}"
+        return False, f"An error occurred during installation: {e!s}"
 
 
 async def install_browser(timeout: int = 300) -> bool:
@@ -220,11 +220,20 @@ async def install_browser(timeout: int = 300) -> bool:
         bool: 是否安装成功。
     """
     async with download_context():
-        logger.info(f"开始安装 <cyan>{plugin_config.htmlrender_browser}</cyan>")
+        logger.opt(colors=True).info(
+            f"Checking <cyan>{plugin_config.htmlrender_browser}</cyan> installation..."
+        )
         installed, message = await execute_install_command(timeout)
         if installed:
-            logger.info("安装成功")
+            logger.info("Installation succeeded")
             return True
         else:
-            logger.error(f"安装失败: {message}")
-            return False
+            logger.warning("Installation failed, retrying with official mirror...")
+            del os.environ["PLAYWRIGHT_DOWNLOAD_HOST"]
+            installed, message = await execute_install_command(timeout)
+            if installed:
+                logger.info("Installation succeeded")
+                return True
+            else:
+                logger.error(f"Installation failed with: {message}")
+                return False

{nonebot_plugin_htmlrender-0.6.0b1 → nonebot_plugin_htmlrender-0.6.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "nonebot-plugin-htmlrender"
-version = "0.6.0-beta.1"
+version = "0.6.2"
 description = "通过浏览器渲染图片"
 readme = "README.md"
 authors = [{ name = "kexue", email = "x@kexue-cloud.cn" }]

{nonebot_plugin_htmlrender-0.6.0b1 → nonebot_plugin_htmlrender-0.6.2}/tests/test_browser.py

@@ -1,7 +1,7 @@
 from collections.abc import AsyncGenerator
 from typing import cast
 
-from playwright.async_api import Browser, Error, Page
+from playwright.async_api import Browser, Page
 import pytest
 from pytest_mock import MockerFixture
 
@@ -65,14 +65,13 @@ async def test_suppress_and_log(mocker: MockerFixture, exception: Exception) ->
 async def test_launch(mocker: MockerFixture, browser_config: dict[str, str]) -> None:
     """测试浏览器启动"""
     from nonebot_plugin_htmlrender.browser import _launch
-    from nonebot_plugin_htmlrender.config import BrowserEngineType
 
     mock_browser_type = mocker.AsyncMock()
     mock_playwright = mocker.MagicMock()
     setattr(mock_playwright, "chromium", mock_browser_type)
 
     mocker.patch("nonebot_plugin_htmlrender.browser._playwright", mock_playwright)
-    await _launch(cast(BrowserEngineType, browser_config["browser"]))
+    await _launch(browser_config["browser"])
 
     mock_browser_type.launch.assert_called_once()
 
@@ -94,27 +93,6 @@ async def test_init_browser_success(
     mock_start.assert_called_once()
 
 
-@pytest.mark.asyncio
-async def test_init_browser_install_fallback(
-    mocker: MockerFixture, mock_browser: Browser
-) -> None:
-    """测试浏览器安装回退"""
-    from nonebot_plugin_htmlrender.browser import init_browser
-
-    mock_start = mocker.patch(
-        "nonebot_plugin_htmlrender.browser.start_browser",
-        side_effect=[Error("Executable doesn't exist"), mock_browser],
-    )
-    mock_install = mocker.patch(
-        "nonebot_plugin_htmlrender.browser.install_browser", return_value=True
-    )
-
-    browser = await init_browser()
-    assert isinstance(browser, Browser)
-    assert mock_start.call_count == 2
-    mock_install.assert_called_once()
-
-
 @pytest.mark.asyncio
 async def test_get_new_page(
     mocker: MockerFixture,
@@ -273,24 +251,3 @@ async def test_start_browser_with_config(mocker: MockerFixture) -> None:
 
     await start_browser()
     mock_launch.assert_called_with(mocker.ANY, channel="chrome-canary")
-
-
-@pytest.mark.asyncio
-async def test_start_browser_failure(mocker: MockerFixture) -> None:
-    """测试浏览器启动失败"""
-    from nonebot_plugin_htmlrender.browser import init_browser
-
-    mock_playwright = mocker.AsyncMock()
-    mock_playwright.start.side_effect = Exception("Failed to start")
-
-    mocker.patch(
-        "nonebot_plugin_htmlrender.browser.async_playwright",
-        return_value=mock_playwright,
-    )
-    mocker.patch("nonebot_plugin_htmlrender.browser._browser", None)
-    mocker.patch("nonebot_plugin_htmlrender.browser._playwright", None)
-
-    with pytest.raises(RuntimeError) as exc_info:
-        await init_browser()
-
-    assert "无法启动浏览器实例" in str(exc_info.value)

{nonebot_plugin_htmlrender-0.6.0b1 → nonebot_plugin_htmlrender-0.6.2}/tests/test_htmlrender.py

@@ -5,6 +5,7 @@ from typing import Any
 from nonebug import App
 from PIL import Image, ImageChops
 import pytest
+from pytest_mock import MockerFixture
 
 
 @pytest.fixture
@@ -39,7 +40,7 @@ def template_resources(request: Any) -> tuple[str, str, list[str]]:
     elif template_type == "text":
         template_name = "text.html"
         data_list = ["1", "2", "3", "4"]
-    else:
+    else:  # pragma: no cover
         raise ValueError(f"Unsupported template type: {template_type}")
 
     return template_path, template_name, data_list
@@ -137,3 +138,75 @@ async def test_template_filter(
     image = Image.open(BytesIO(initial_bytes=image_byte))
     diff = ImageChops.difference(image, test_image)
     assert diff.getbbox() is None
+
+
+@pytest.mark.asyncio
+async def test_capture_element(mocker: MockerFixture) -> None:
+    """测试网页元素捕获功能"""
+    from nonebot_plugin_htmlrender.data_source import capture_element
+
+    mock_screenshot = b"test_image_bytes"
+
+    mock_locator = mocker.AsyncMock()
+    mock_locator.screenshot.return_value = mock_screenshot
+
+    mock_page = mocker.AsyncMock()
+    mock_page.goto = mocker.AsyncMock()
+    mock_page.on = mocker.AsyncMock()
+    mock_page.locator = mocker.MagicMock(return_value=mock_locator)
+
+    mock_cm = mocker.MagicMock()
+    mock_cm.__aenter__ = mocker.AsyncMock(return_value=mock_page)
+    mock_cm.__aexit__ = mocker.AsyncMock(return_value=None)
+
+    mocker.patch(
+        "nonebot_plugin_htmlrender.data_source.get_new_page", return_value=mock_cm
+    )
+
+    result = await capture_element("https://example.com", "#target-element")
+
+    assert result == mock_screenshot
+    mock_page.goto.assert_called_once_with("https://example.com")
+    mock_page.locator.assert_called_once_with("#target-element")
+    mock_locator.screenshot.assert_called_once_with()
+
+    mock_page.goto.reset_mock()
+    mock_page.locator.reset_mock()
+    mock_locator.screenshot.reset_mock()
+
+    page_kwargs = {"device_scale_factor": 2.0}
+    goto_kwargs = {"timeout": 5000}
+    screenshot_kwargs = {"type": "jpeg", "quality": 80}
+
+    result = await capture_element(
+        "https://example.com",
+        "//div[@id='xpath-element']",
+        page_kwargs=page_kwargs,
+        goto_kwargs=goto_kwargs,
+        screenshot_kwargs=screenshot_kwargs,
+    )
+
+    assert result == mock_screenshot
+    mock_page.goto.assert_called_once_with("https://example.com", timeout=5000)
+    mock_page.locator.assert_called_once_with("//div[@id='xpath-element']")
+    mock_locator.screenshot.assert_called_once_with(type="jpeg", quality=80)
+
+
+@pytest.mark.asyncio
+async def test_capture_element_exceptions_propagate(mocker: MockerFixture) -> None:
+    """测试网页元素捕获时的异常能正确传递"""
+    from playwright.async_api import Error
+
+    from nonebot_plugin_htmlrender.data_source import capture_element
+
+    mock_cm = mocker.MagicMock()
+    mock_cm.__aenter__ = mocker.AsyncMock(side_effect=Error("Browser error"))
+
+    mocker.patch(
+        "nonebot_plugin_htmlrender.data_source.get_new_page", return_value=mock_cm
+    )
+
+    with pytest.raises(Error) as exc_info:
+        await capture_element("https://example.com", "#element")
+
+    assert "Browser error" in str(exc_info.value)

{nonebot_plugin_htmlrender-0.6.0b1 → nonebot_plugin_htmlrender-0.6.2}/tests/test_install.py

@@ -86,7 +86,7 @@ async def test_execute_install_command(mocker: MockerFixture, mock_stream):
 
     success, message = await execute_install_command(timeout=5)
     assert success
-    assert "安装完成" in message
+    assert "Installation completed" in message
 
 
 @pytest.mark.asyncio
@@ -111,7 +111,7 @@ async def test_execute_install_command_timeout(mocker: MockerFixture, mock_strea
     success, message = await execute_install_command(timeout=1)
 
     assert not success
-    assert message == "安装超时 (1s)"
+    assert message == "Timed out (1s)"
     mock_terminate.assert_called_once_with(mock_process)