nonebot-plugin-htmlrender 0.6.8__tar.gz → 0.7.0a2__tar.gz

nonebot_plugin_htmlrender-0.7.0a2/.github/workflows/_test-os-arch.yml

@@ -0,0 +1,67 @@
+on:
+  workflow_call:
+    inputs:
+      python-version:
+        required: true
+        type: string
+
+jobs:
+  test:
+    name: Test (Py ${{ inputs.python-version }} — ${{ matrix.os_label }})
+    runs-on: ${{ matrix.runs_on }}
+    strategy:
+      fail-fast: true
+      matrix:
+        include:
+          - runs_on: ubuntu-latest
+            os_label: ubuntu-latest x64
+            arch: x64
+            platform: linux
+
+          - runs_on: macos-latest
+            os_label: macos-latest arm64
+            arch: arm64
+            platform: macos
+
+          - runs_on: windows-latest
+            os_label: windows-latest x64
+            arch: x64
+            platform: windows
+
+          - runs_on: ubuntu-24.04-arm
+            os_label: ubuntu-24.04-arm arm64
+            arch: arm64
+            platform: linux
+
+    env:
+      OS: ${{ matrix.os_label }}
+      PYTHON_VERSION: ${{ inputs.python-version }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ inputs.python-version }}
+          enable-cache: true
+          cache-suffix: ${{ matrix.runs_on }}-${{ inputs.python-version }}
+
+      - name: Sync deps
+        run: uv sync --locked --all-extras --dev
+
+      - name: Install Playwright (Linux)
+        if: matrix.platform == 'linux'
+        run: uv run playwright install --with-deps && uv run playwright install --with-deps
+      - name: Install Playwright (non-Linux)
+        if: matrix.platform != 'linux'
+        run: uv run playwright install && uv run playwright install
+
+      - name: Run tests
+        run: uv run pytest -s -n auto
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          env_vars: OS,PYTHON_VERSION
+          verbose: true

nonebot_plugin_htmlrender-0.7.0a2/.github/workflows/codecov.yml

@@ -0,0 +1,20 @@
+name: Code Coverage
+
+on:
+  push:
+    branches: [ master, dev , feat/*]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  per-python:
+    name: Python ${{ matrix.python-version }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [ "3.9", "3.10", "3.11", "3.12", "3.13" ]
+
+    uses: ./.github/workflows/_test-os-arch.yml
+    with:
+      python-version: ${{ matrix.python-version }}
+    secrets: inherit

{nonebot_plugin_htmlrender-0.6.8 → nonebot_plugin_htmlrender-0.7.0a2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nonebot-plugin-htmlrender
-Version: 0.6.8
+Version: 0.7.0a2
 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
@@ -37,6 +37,7 @@ Requires-Dist: playwright>=1.48.0
 Requires-Dist: pygments>=2.10.0
 Requires-Dist: pymdown-extensions>=9.1
 Requires-Dist: python-markdown-math>=0.8
+Requires-Dist: tenacity>=9.1.2
 Description-Content-Type: text/markdown
 
 # nonebot-plugin-htmlrender

{nonebot_plugin_htmlrender-0.6.8 → nonebot_plugin_htmlrender-0.7.0a2}/nonebot_plugin_htmlrender/browser.py

@@ -1,5 +1,5 @@
 from collections.abc import AsyncIterator
-from contextlib import asynccontextmanager
+from contextlib import AsyncExitStack, asynccontextmanager
 from typing import Optional
 
 from nonebot.log import logger
@@ -10,6 +10,7 @@ from playwright.async_api import (
     Playwright,
     async_playwright,
 )
+from tenacity import retry, retry_if_exception_type, stop_after_attempt, wait_fixed
 
 from nonebot_plugin_htmlrender.config import plugin_config
 from nonebot_plugin_htmlrender.install import install_browser
@@ -127,7 +128,30 @@ async def _connect(browser_type: str, **kwargs) -> Browser:
     if _playwright is not None:
         return await _browser_cls.connect(**kwargs)
     else:
-        raise RuntimeError("Playwright 未初始化")
+        raise RuntimeError("Playwright is not initialized")
+
+
+@retry(
+    retry=retry_if_exception_type(RuntimeError),
+    stop=stop_after_attempt(4),
+    wait=wait_fixed(1),
+    reraise=True,
+    before_sleep=lambda retry_state: logger.warning(
+        f"Attempt {retry_state.attempt_number} failed, retrying..."
+    ),
+)
+async def _check_env_with_install_retry(**kwargs):
+    try:
+        return await check_playwright_env(**kwargs)
+    except RuntimeError:
+        if plugin_config.htmlrender_ci_mode:
+            raise
+        try:
+            await install_browser()
+        except Exception as e:
+            logger.error(f"Browser installation failed: {e!s}")
+            raise RuntimeError(f"install_browser failed: {e}") from e
+        raise
 
 
 @with_lock
@@ -144,8 +168,10 @@ async def startup_htmlrender(**kwargs) -> Browser:
     global _browser, _playwright
 
     await shutdown_htmlrender()
-    clean_playwright_cache()
-    _prepare_playwright_env_vars()
+
+    if not plugin_config.htmlrender_ci_mode:
+        clean_playwright_cache()
+        _prepare_playwright_env_vars()
 
     _playwright = await async_playwright().start()
     logger.debug("Playwright started")
@@ -177,31 +203,69 @@ async def startup_htmlrender(**kwargs) -> Browser:
                     f" '{plugin_config.htmlrender_browser_executable_path}': {e}"
                 ) from e
         else:
-            try:
-                _browser = await check_playwright_env(**kwargs)
-            except RuntimeError:
-                await install_browser()
-                _browser = await check_playwright_env(**kwargs)
+            _browser = await _check_env_with_install_retry(**kwargs)
 
     return _browser
 
 
 async def shutdown_htmlrender() -> None:
-    """关闭浏览器和 Playwright 实例。"""
-    if _browser:
-        if not _browser.is_connected():
-            logger.info("Browser was already disconnected, skipping close.")
-        else:
-            with suppress_and_log():
-                logger.debug("Disconnecting browser...")
-                await _browser.close()
-                logger.info("Disconnected browser.")
-    if _playwright:
+    is_remote = bool(
+        plugin_config.htmlrender_connect or plugin_config.htmlrender_connect_over_cdp
+    )
+    async with AsyncExitStack() as stack:
+        await _schedule_browser_shutdown(stack, is_remote=is_remote)
+        await _schedule_playwright_shutdown(stack)
+    _clear_globals()
+
+
+async def _schedule_browser_shutdown(stack: AsyncExitStack, *, is_remote: bool) -> None:
+    global _browser
+    if not _browser:
+        return
+
+    should_close = (not is_remote) and plugin_config.htmlrender_shutdown_browser_on_exit
+    if not should_close:
+        logger.info(
+            "Skipping browser shutdown due to configuration or remote connection."
+        )
+        return
+
+    browser = _browser
+    if not browser.is_connected():
+        logger.info("Browser was already disconnected.")
+        return
+
+    logger.debug("Disconnecting browser...")
+
+    async def _close_browser():
+        with suppress_and_log():
+            await browser.close()
+            logger.info("Disconnected browser.")
+
+    stack.push_async_callback(_close_browser)
+
+
+async def _schedule_playwright_shutdown(stack: AsyncExitStack) -> None:
+    global _playwright
+    if not _playwright:
+        return
+
+    pw = _playwright
+    logger.debug("Stopping Playwright...")
+
+    async def _stop_pw():
         with suppress_and_log():
-            logger.debug("Stopping Playwright...")
-            await _playwright.stop()
+            await pw.stop()
             logger.info("Playwright stopped.")
 
+    stack.push_async_callback(_stop_pw)
+
+
+def _clear_globals() -> None:
+    global _browser, _playwright
+    _browser = None
+    _playwright = None
+
 
 async def check_playwright_env(**kwargs) -> Browser:
     """

{nonebot_plugin_htmlrender-0.6.8 → nonebot_plugin_htmlrender-0.7.0a2}/nonebot_plugin_htmlrender/config.py

@@ -3,6 +3,7 @@ from typing import Any, Optional
 
 from nonebot import get_driver, get_plugin_config
 from nonebot.compat import model_validator
+from nonebot.log import logger
 import nonebot_plugin_localstore as store
 from pydantic import BaseModel, Field
 
@@ -32,6 +33,14 @@ class Config(BaseModel):
         default=plugin_config_dir,
         description="配置路径，不填则使用 `nonebot-plugin-localstore` 管理",
     )
+    htmlrender_shutdown_browser_on_exit: bool = Field(
+        default=True,
+        description="在插件关闭时关闭浏览器实例，在连接到远程浏览器时默认为 False。",
+    )
+    htmlrender_ci_mode: bool = Field(
+        default=False,
+        description="启用CI模式，跳过浏览器安装和环境变量",
+    )
     htmlrender_download_host: Optional[str] = Field(
         default=None, description="下载Playwright浏览器时的主机地址。"
     )
@@ -93,3 +102,8 @@ class Config(BaseModel):
 
 global_config = get_driver().config
 plugin_config = get_plugin_config(Config)
+
+if plugin_config.htmlrender_ci_mode:
+    logger.info(
+        "CI mode enabled, skipping browser installation and environment variable setup."
+    )

{nonebot_plugin_htmlrender-0.6.8 → nonebot_plugin_htmlrender-0.7.0a2}/nonebot_plugin_htmlrender/install.py

@@ -4,6 +4,7 @@ from contextlib import asynccontextmanager
 import os
 from typing import Callable, Optional
 from urllib.parse import urlparse
+import sys
 
 from nonebot import logger
 
@@ -171,6 +172,8 @@ async def execute_install_command(timeout: int) -> tuple[bool, str]:
         install_signal_handler()
 
         process = await create_process(
+            sys.executable,
+            "-m",
             "playwright",
             "install",
             "--with-deps",
@@ -202,7 +205,7 @@ async def execute_install_command(timeout: int) -> tuple[bool, str]:
                 asyncio.gather(stdout_task, stderr_task), timeout=timeout
             )
         except asyncio.TimeoutError:
-            logger.error(f"Timed out ({timeout}秒)")
+            logger.error(f"Timed out ({timeout}s)")
             await terminate_process(process)
             return False, f"Timed out ({timeout}s)"
 

{nonebot_plugin_htmlrender-0.6.8 → nonebot_plugin_htmlrender-0.7.0a2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "nonebot-plugin-htmlrender"
-version = "0.6.8"
+version = "0.7.0.alpha.2"
 description = "通过浏览器渲染图片"
 readme = "README.md"
 authors = [{ name = "kexue", email = "x@kexue-cloud.cn" }]
@@ -16,6 +16,7 @@ dependencies = [
     "pygments>=2.10.0",
     "pymdown-extensions>=9.1",
     "python-markdown-math>=0.8",
+    "tenacity>=9.1.2",
 ]
 
 [project.urls]

nonebot_plugin_htmlrender-0.7.0a2/tests/conftest.py

@@ -0,0 +1,42 @@
+import gc
+
+import anyio
+import nonebot
+from nonebug import NONEBOT_INIT_KWARGS
+import pytest
+from pytest_asyncio import is_async_test
+
+
+def pytest_configure(config: pytest.Config) -> None:
+    config.stash[NONEBOT_INIT_KWARGS] = {
+        "superusers": {"10001"},
+        "command_start": {""},
+        "log_level": "DEBUG",
+        "htmlrender_ci_mode": True,
+    }
+
+
+def pytest_collection_modifyitems(items: list[pytest.Item]):
+    pytest_asyncio_tests = (item for item in items if is_async_test(item))
+    session_scope_marker = pytest.mark.asyncio(loop_scope="session")
+    for async_test in pytest_asyncio_tests:
+        async_test.add_marker(session_scope_marker, append=False)
+
+
+@pytest.fixture(scope="session", autouse=True)
+async def after_nonebot_init(after_nonebot_init: None):
+    nonebot.require("nonebot_plugin_htmlrender")
+
+
+@pytest.fixture(scope="session", autouse=True)
+async def _cleanup_playwright_session():
+    from nonebot_plugin_htmlrender import shutdown_htmlrender
+
+    yield
+
+    await shutdown_htmlrender()
+
+    gc.collect()
+    gc.collect()
+
+    await anyio.lowlevel.checkpoint()

{nonebot_plugin_htmlrender-0.6.8 → nonebot_plugin_htmlrender-0.7.0a2}/tests/test_htmlrender.py

@@ -152,7 +152,8 @@ async def test_capture_element(mocker: MockerFixture) -> None:
 
     mock_page = mocker.AsyncMock()
     mock_page.goto = mocker.AsyncMock()
-    mock_page.on = mocker.AsyncMock()
+    mock_page.on = mocker.MagicMock()
+    mock_page.off = mocker.MagicMock()
     mock_page.locator = mocker.MagicMock(return_value=mock_locator)
 
     mock_cm = mocker.MagicMock()