nonebot-plugin-receipts 0.2.3__tar.gz → 0.2.4__tar.gz

{nonebot_plugin_receipts-0.2.3 → nonebot_plugin_receipts-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nonebot_plugin_receipts
-Version: 0.2.3
+Version: 0.2.4
 Summary: NoneBot2 plugin for sending text and image messages to receipts-spooler
 Project-URL: homepage, https://github.com/Effect-Wei/nonebot_plugin_receipts
 Project-URL: repository, https://github.com/Effect-Wei/nonebot_plugin_receipts

{nonebot_plugin_receipts-0.2.3 → nonebot_plugin_receipts-0.2.4}/nonebot_plugin_receipts/__init__.py

@@ -8,7 +8,8 @@ __plugin_meta__ = PluginMetadata(
     name="小票打印",
     description="将发送给 Bot 的文本和图片消息通过 receipts-spooler 打印",
     usage=(
-        "发送 /ticket 或 /receipt 后附带文本/图片，或单独发送命令后按提示再发送一条要打印的消息。"
+        "发送 /ticket 或 /receipt 后附带文本/图片，"
+        "或单独发送命令后按提示再发送一条要打印的消息。"
     ),
     type="application",
     config=Config,

{nonebot_plugin_receipts-0.2.3 → nonebot_plugin_receipts-0.2.4}/nonebot_plugin_receipts/command_handlers.py

@@ -112,8 +112,8 @@ def get_runtime_config() -> Config:
 def is_receipt_submission_allowed(event: MessageEvent) -> bool:
     """Return whether the incoming event is allowed to submit a print job."""
     config = get_runtime_config()
-    allowed_user_ids = set(config.receipt_allowed_user_ids)
-    allowed_group_ids = set(config.receipt_allowed_group_ids)
+    allowed_user_ids = set(config.allowed_user_ids)
+    allowed_group_ids = set(config.allowed_group_ids)
 
     if not allowed_user_ids and not allowed_group_ids:
         return True

{nonebot_plugin_receipts-0.2.3 → nonebot_plugin_receipts-0.2.4}/nonebot_plugin_receipts/config.py

@@ -5,6 +5,31 @@ from typing import Any, Literal
 from pydantic import BaseModel, Field, field_validator
 
 
+def normalize_whitelist_ids(value: Any) -> list[str]:
+    if value is None:
+        return []
+
+    if isinstance(value, str):
+        stripped = value.strip()
+        if not stripped:
+            return []
+
+        try:
+            value = json.loads(stripped)
+        except json.JSONDecodeError:
+            return [
+                item
+                for part in re.split(r"[\s,，]+", stripped)
+                if (item := part.strip())
+            ]
+
+    if isinstance(value, list | tuple | set | frozenset):
+        return [item for entry in value if (item := str(entry).strip())]
+
+    item = str(value).strip()
+    return [item] if item else []
+
+
 class Config(BaseModel):
     receipts_spooler_url: str = "http://127.0.0.1:8000"
     receipts_spooler_token: str | None = None
@@ -20,8 +45,8 @@ class Config(BaseModel):
     receipt_session_timeout_seconds: int = Field(default=120, ge=10, le=3600)
     receipt_feed_lines: int = Field(default=4, ge=0, le=10)
     receipt_enable_cut: bool = True
-    receipt_allowed_user_ids: list[str] = Field(default_factory=list)
-    receipt_allowed_group_ids: list[str] = Field(default_factory=list)
+    receipt_allowed_user_ids: str | list[str] | None = Field(default_factory=list)
+    receipt_allowed_group_ids: str | list[str] | None = Field(default_factory=list)
 
     @field_validator(
         "receipt_allowed_user_ids",
@@ -30,25 +55,12 @@ class Config(BaseModel):
     )
     @classmethod
     def normalize_whitelist_ids(cls, value: Any) -> list[str]:
-        if value is None:
-            return []
+        return normalize_whitelist_ids(value)
+
+    @property
+    def allowed_user_ids(self) -> list[str]:
+        return normalize_whitelist_ids(self.receipt_allowed_user_ids)
 
-        if isinstance(value, str):
-            stripped = value.strip()
-            if not stripped:
-                return []
-
-            try:
-                value = json.loads(stripped)
-            except json.JSONDecodeError:
-                return [
-                    item
-                    for part in re.split(r"[\s,，]+", stripped)
-                    if (item := part.strip())
-                ]
-
-        if isinstance(value, list | tuple | set | frozenset):
-            return [item for entry in value if (item := str(entry).strip())]
-
-        item = str(value).strip()
-        return [item] if item else []
+    @property
+    def allowed_group_ids(self) -> list[str]:
+        return normalize_whitelist_ids(self.receipt_allowed_group_ids)

{nonebot_plugin_receipts-0.2.3 → nonebot_plugin_receipts-0.2.4}/nonebot_plugin_receipts.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nonebot_plugin_receipts
-Version: 0.2.3
+Version: 0.2.4
 Summary: NoneBot2 plugin for sending text and image messages to receipts-spooler
 Project-URL: homepage, https://github.com/Effect-Wei/nonebot_plugin_receipts
 Project-URL: repository, https://github.com/Effect-Wei/nonebot_plugin_receipts

{nonebot_plugin_receipts-0.2.3 → nonebot_plugin_receipts-0.2.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "nonebot_plugin_receipts"
-version = "0.2.3"
+version = "0.2.4"
 description = "NoneBot2 plugin for sending text and image messages to receipts-spooler"
 readme = "README.md"
 requires-python = ">=3.12, <4.0"

{nonebot_plugin_receipts-0.2.3 → nonebot_plugin_receipts-0.2.4}/tests/test_command_handlers.py

@@ -114,6 +114,14 @@ class DummyPluginConfig:
         self.receipt_allowed_user_ids = allowed_user_ids or []
         self.receipt_allowed_group_ids = allowed_group_ids or []
 
+    @property
+    def allowed_user_ids(self) -> list[str]:
+        return self.receipt_allowed_user_ids
+
+    @property
+    def allowed_group_ids(self) -> list[str]:
+        return self.receipt_allowed_group_ids
+
 
 class CommandHandlersTestCase(unittest.TestCase):
     def setUp(self) -> None:

nonebot_plugin_receipts-0.2.4/tests/test_config.py

@@ -0,0 +1,69 @@
+from __future__ import annotations
+
+import os
+import unittest
+from unittest.mock import patch
+
+from nonebot.config import BaseSettings
+from nonebot_plugin_receipts.config import Config
+
+
+class ConfigTestCase(unittest.TestCase):
+    def test_whitelist_defaults_to_empty_lists(self) -> None:
+        config = Config()
+
+        self.assertEqual(config.allowed_user_ids, [])
+        self.assertEqual(config.allowed_group_ids, [])
+
+    def test_whitelist_accepts_comma_separated_strings(self) -> None:
+        config = Config.model_validate(
+            {
+                "receipt_allowed_user_ids": "123456, 234567，345678",
+                "receipt_allowed_group_ids": "456789 567890",
+            }
+        )
+
+        self.assertEqual(
+            config.allowed_user_ids,
+            ["123456", "234567", "345678"],
+        )
+        self.assertEqual(
+            config.allowed_group_ids,
+            ["456789", "567890"],
+        )
+
+    def test_whitelist_accepts_json_arrays(self) -> None:
+        config = Config.model_validate(
+            {
+                "receipt_allowed_user_ids": '["123456", 234567, ""]',
+                "receipt_allowed_group_ids": [456789, "567890", ""],
+            }
+        )
+
+        self.assertEqual(config.allowed_user_ids, ["123456", "234567"])
+        self.assertEqual(config.allowed_group_ids, ["456789", "567890"])
+
+    def test_whitelist_accepts_nonebot_env_style_values(self) -> None:
+        with patch.dict(
+            os.environ,
+            {
+                "RECEIPT_ALLOWED_USER_IDS": "123456,234567",
+                "RECEIPT_ALLOWED_GROUP_IDS": "[\"345678\", \"456789\"]",
+            },
+            clear=False,
+        ):
+            values = BaseSettings._settings_build_values(
+                Config,
+                {},
+                env_file=None,
+                env_file_encoding="utf-8",
+                env_nested_delimiter="__",
+            )
+            config = Config.model_validate(values)
+
+        self.assertEqual(config.allowed_user_ids, ["123456", "234567"])
+        self.assertEqual(config.allowed_group_ids, ["345678", "456789"])
+
+
+if __name__ == "__main__":
+    unittest.main()

nonebot_plugin_receipts-0.2.3/tests/test_config.py

@@ -1,45 +0,0 @@
-from __future__ import annotations
-
-import unittest
-
-from nonebot_plugin_receipts.config import Config
-
-
-class ConfigTestCase(unittest.TestCase):
-    def test_whitelist_defaults_to_empty_lists(self) -> None:
-        config = Config()
-
-        self.assertEqual(config.receipt_allowed_user_ids, [])
-        self.assertEqual(config.receipt_allowed_group_ids, [])
-
-    def test_whitelist_accepts_comma_separated_strings(self) -> None:
-        config = Config.model_validate(
-            {
-                "receipt_allowed_user_ids": "123456, 234567，345678",
-                "receipt_allowed_group_ids": "456789 567890",
-            }
-        )
-
-        self.assertEqual(
-            config.receipt_allowed_user_ids,
-            ["123456", "234567", "345678"],
-        )
-        self.assertEqual(
-            config.receipt_allowed_group_ids,
-            ["456789", "567890"],
-        )
-
-    def test_whitelist_accepts_json_arrays(self) -> None:
-        config = Config.model_validate(
-            {
-                "receipt_allowed_user_ids": '["123456", 234567, ""]',
-                "receipt_allowed_group_ids": [456789, "567890", ""],
-            }
-        )
-
-        self.assertEqual(config.receipt_allowed_user_ids, ["123456", "234567"])
-        self.assertEqual(config.receipt_allowed_group_ids, ["456789", "567890"])
-
-
-if __name__ == "__main__":
-    unittest.main()