mqs-compat 0.3.0__tar.gz

mqs_compat-0.3.0/.gitignore

@@ -0,0 +1,34 @@
+# Rust
+/target/
+**/*.rs.bk
+
+# Node / frontend
+web/node_modules/
+web/dist/
+desktop/node_modules/
+
+# Python shim
+__pycache__/
+*.py[cod]
+*.egg-info/
+python/build/
+python/dist/
+
+# Sandbox runtime data
+profiles/
+.mqs/
+runtime.json
+*.sqlite
+*.sqlite-wal
+*.sqlite-shm
+
+# Build artifacts
+dist/
+build/
+*.spec
+*.log
+.env
+.DS_Store
+
+# Harness memory/state
+.dsh/

mqs_compat-0.3.0/PKG-INFO

@@ -0,0 +1,36 @@
+Metadata-Version: 2.5
+Name: mqs-compat
+Version: 0.3.0
+Summary: Point the real QQ SDKs (botpy) at a running QSandbox — Python-only compatibility shim
+Project-URL: Homepage, https://github.com/Moonlark-Dev/qsandbox
+Project-URL: Repository, https://github.com/Moonlark-Dev/qsandbox
+Author: Moonlark Dev Team
+License-Expression: AGPL-3.0-or-later
+Keywords: botpy,moonlark,qqbot,sandbox
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.9
+Provides-Extra: botpy
+Requires-Dist: qq-botpy; extra == 'botpy'
+Description-Content-Type: text/markdown
+
+# mqs-compat
+
+Python-only companion of [QSandbox](https://github.com/Moonlark-Dev/qsandbox).
+
+The sandbox itself is a Rust binary; only the *SDK shim* stays in Python, because
+`botpy` hardcodes its endpoints and monkeypatching it is a Python-only job.
+
+```python
+import mqs.compat.botpy  # noqa: F401 — before creating botpy.Client
+import botpy
+
+client = botpy.Client(intents=botpy.Intents(public_messages=True))
+client.run(appid="10000", secret="mqs-secret-10000")
+```
+
+`MQS_BASE_URL` (default `http://127.0.0.1:5700`) or `patch("http://host:port")`
+selects the sandbox. `patch_from_runtime()` reads `profiles/<name>/runtime.json`
+written by `mqs serve`.

mqs_compat-0.3.0/README.md

@@ -0,0 +1,18 @@
+# mqs-compat
+
+Python-only companion of [QSandbox](https://github.com/Moonlark-Dev/qsandbox).
+
+The sandbox itself is a Rust binary; only the *SDK shim* stays in Python, because
+`botpy` hardcodes its endpoints and monkeypatching it is a Python-only job.
+
+```python
+import mqs.compat.botpy  # noqa: F401 — before creating botpy.Client
+import botpy
+
+client = botpy.Client(intents=botpy.Intents(public_messages=True))
+client.run(appid="10000", secret="mqs-secret-10000")
+```
+
+`MQS_BASE_URL` (default `http://127.0.0.1:5700`) or `patch("http://host:port")`
+selects the sandbox. `patch_from_runtime()` reads `profiles/<name>/runtime.json`
+written by `mqs serve`.

mqs_compat-0.3.0/mqs/__init__.py

@@ -0,0 +1,8 @@
+"""QSandbox Python companion — the SDK shim only.
+
+The sandbox server, CLI and control API are the Rust ``mqs`` binary; this
+package exists so that QQ SDKs which hardcode their endpoints (botpy) can be
+pointed at a running sandbox without editing the SDK.
+"""
+
+__version__ = "0.3.0"

mqs_compat-0.3.0/mqs/compat/__init__.py

@@ -0,0 +1,5 @@
+"""SDK compatibility shims (Python-only, not part of the Rust binary)."""
+
+from .botpy import patch, patch_from_runtime
+
+__all__ = ["patch", "patch_from_runtime"]

mqs_compat-0.3.0/mqs/compat/botpy.py

@@ -0,0 +1,78 @@
+"""Point the real botpy SDK at QSandbox.
+
+botpy hardcodes both the REST domain (``botpy.http.Route.DOMAIN``) and the
+access-token URL (``https://bots.qq.com/app/getAppAccessToken``), so a
+``base_url`` config alone cannot work. This module monkeypatches both.
+
+Usage::
+
+    import mqs.compat.botpy  # noqa: F401  — before creating botpy.Client
+    from botpy import Client
+
+    Client(intents=Intents(public_messages=True), is_sandbox=False)
+
+Set ``MQS_BASE_URL`` (default ``http://127.0.0.1:5700``) or call
+``mqs.compat.botpy.patch("http://127.0.0.1:1234")`` explicitly.
+"""
+
+from __future__ import annotations
+
+import json
+import os
+import time
+from pathlib import Path
+from urllib.parse import urlparse
+
+
+def patch(base_url: str | None = None) -> str:
+    base_url = (base_url or os.environ.get("MQS_BASE_URL") or "http://127.0.0.1:5700").rstrip("/")
+    parsed = urlparse(base_url)
+    if parsed.scheme not in ("http", "https") or not parsed.netloc:
+        raise ValueError(f"invalid base_url: {base_url}")
+
+    try:
+        import botpy.robot as bot_robot
+        from botpy import http as bot_http
+    except ImportError as exc:  # pragma: no cover
+        raise RuntimeError("botpy is not installed; pip install qq-botpy") from exc
+
+    bot_http.Route.SCHEME = parsed.scheme
+    bot_http.Route.DOMAIN = parsed.netloc
+    bot_http.Route.SANDBOX_DOMAIN = parsed.netloc
+
+    async def update_access_token(self) -> None:  # type: ignore[no-untyped-def]
+        import aiohttp
+
+        async with aiohttp.ClientSession() as session:
+            async with session.post(
+                f"{base_url}/app/getAppAccessToken",
+                json={"appId": self.app_id, "clientSecret": self.secret},
+                timeout=aiohttp.ClientTimeout(total=20),
+            ) as response:
+                data = await response.json()
+        if "access_token" not in data or "expires_in" not in data:
+            raise RuntimeError(f"mqs rejected the bot credentials: {data}")
+        self.access_token = data["access_token"]
+        self.expires_in = int(data["expires_in"]) + int(time.time())
+
+    bot_robot.Token.update_access_token = update_access_token
+    return base_url
+
+
+def patch_from_runtime(home: str | None = None, profile: str | None = None) -> str:
+    """Read ``profiles/<name>/runtime.json`` (written by ``mqs serve``) and patch."""
+    home_path = Path(home or os.environ.get("MQS_HOME") or "~/.mqs").expanduser()
+    name = profile or os.environ.get("MQS_PROFILE") or "default"
+    runtime = home_path / "profiles" / name / "runtime.json"
+    try:
+        payload = json.loads(runtime.read_text(encoding="utf-8"))
+    except FileNotFoundError as exc:
+        raise RuntimeError(f"no running QSandbox server for profile {name!r} ({runtime} missing)") from exc
+    return patch(payload["base_url"])
+
+
+# importing the module is enough for the default local setup
+try:
+    patch()
+except (RuntimeError, ValueError):  # botpy not installed — the shim keeps working
+    pass

mqs_compat-0.3.0/pyproject.toml

@@ -0,0 +1,31 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "mqs-compat"
+version = "0.3.0"
+description = "Point the real QQ SDKs (botpy) at a running QSandbox — Python-only compatibility shim"
+readme = "README.md"
+requires-python = ">=3.9"
+license = "AGPL-3.0-or-later"
+authors = [{ name = "Moonlark Dev Team" }]
+keywords = ["qqbot", "sandbox", "botpy", "moonlark"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Topic :: Software Development :: Testing",
+]
+# The shim has no hard dependency: it only imports botpy when patching it.
+dependencies = []
+
+[project.optional-dependencies]
+botpy = ["qq-botpy"]
+
+[project.urls]
+Homepage = "https://github.com/Moonlark-Dev/qsandbox"
+Repository = "https://github.com/Moonlark-Dev/qsandbox"
+
+[tool.hatch.build.targets.wheel]
+packages = ["mqs"]