simplex-chat 6.5.1__py3-none-any.whl

simplex_chat/util.py

@@ -0,0 +1,128 @@
+"""Reusable helpers for working with chat events, types, and message content.
+
+Mirrors the Node `util.ts` exports — provides the same primitives bot
+authors typically reach for: command parsing, sender display strings,
+message-content extraction, profile field cleanup, and ChatRef extraction
+from a ChatInfo (handy when echoing into a different chat).
+"""
+
+from __future__ import annotations
+
+import re
+from typing import Any
+
+from .types import T
+
+
+def chat_info_ref(c_info: T.ChatInfo) -> T.ChatRef | None:
+    """Extract a wire-format `ChatRef` from a `ChatInfo`.
+
+    Returns `None` for non-chat infos (contactRequest, contactConnection)
+    that can't be the target of `api_send_messages`. For groups, the
+    `memberSupport` scope is forwarded so messages land in the right
+    thread; other scopes are dropped (matches Node `util.chatInfoRef`).
+    """
+    t = c_info["type"]
+    if t == "direct":
+        return {"chatType": "direct", "chatId": c_info["contact"]["contactId"]}  # type: ignore[index]
+    if t == "group":
+        ref: T.ChatRef = {"chatType": "group", "chatId": c_info["groupInfo"]["groupId"]}  # type: ignore[index]
+        scope = c_info.get("groupChatScope")  # type: ignore[union-attr]
+        if scope and scope.get("type") == "memberSupport":
+            member = scope.get("groupMember_")
+            ms_scope: T.GroupChatScope_memberSupport = {"type": "memberSupport"}
+            if member is not None:
+                ms_scope["groupMemberId_"] = member["groupMemberId"]
+            ref["chatScope"] = ms_scope
+        return ref
+    return None
+
+
+def chat_info_name(c_info: T.ChatInfo) -> str:
+    """Display string for a chat: `@Alice`, `#GroupName`, `private notes`, etc."""
+    t = c_info["type"]
+    if t == "direct":
+        return f"@{c_info['contact']['profile']['displayName']}"  # type: ignore[index]
+    if t == "group":
+        scope = c_info.get("groupChatScope")  # type: ignore[union-attr]
+        if scope and scope.get("type") == "memberSupport":
+            member = scope.get("groupMember_")
+            scope_name = f" {member['memberProfile']['displayName']}" if member else ""
+            return f"#{c_info['groupInfo']['groupProfile']['displayName']}(support{scope_name})"  # type: ignore[index]
+        return f"#{c_info['groupInfo']['groupProfile']['displayName']}"  # type: ignore[index]
+    if t == "local":
+        return "private notes"
+    if t == "contactRequest":
+        return f"request from @{c_info['contactRequest']['profile']['displayName']}"  # type: ignore[index]
+    if t == "contactConnection":
+        alias = c_info["contactConnection"].get("localAlias")  # type: ignore[index]
+        return f"pending connection ({alias})" if alias else "pending connection"
+    return f"<{t}>"
+
+
+def sender_name(c_info: T.ChatInfo, chat_dir: T.CIDirection) -> str:
+    """Sender display: chat name plus group sender suffix when applicable."""
+    base = chat_info_name(c_info)
+    if chat_dir["type"] == "groupRcv":
+        sender = chat_dir["groupMember"]["memberProfile"]["displayName"]  # type: ignore[index]
+        return f"{base} @{sender}"
+    return base
+
+
+def contact_address_str(link: T.CreatedConnLink) -> str:
+    """Prefer the short link, fall back to the full link."""
+    return link.get("connShortLink") or link["connFullLink"]
+
+
+def from_local_profile(local: T.LocalProfile) -> T.Profile:
+    """Strip extra LocalProfile fields (profileId, localAlias) and undefined values."""
+    p: dict[str, Any] = {}
+    for key in (
+        "displayName",
+        "fullName",
+        "shortDescr",
+        "image",
+        "contactLink",
+        "preferences",
+        "peerType",
+    ):
+        v = local.get(key)  # type: ignore[misc]
+        if v is not None:
+            p[key] = v
+    return p  # type: ignore[return-value]
+
+
+def ci_content_text(chat_item: T.ChatItem) -> str | None:
+    """Extract the message text from a sent or received message item, if any."""
+    content = chat_item["content"]
+    if content["type"] in ("sndMsgContent", "rcvMsgContent"):
+        msg = content.get("msgContent", {})  # type: ignore[union-attr]
+        return msg.get("text")
+    return None
+
+
+_BOT_COMMAND_RE = re.compile(r"^/([^\s]+)(.*)$")
+
+
+def ci_bot_command(chat_item: T.ChatItem) -> tuple[str, str] | None:
+    """Parse a `/keyword args...` slash-command from a chat item.
+
+    Returns `(keyword, trimmed_params)` or `None` if the message isn't a
+    slash command. Mirrors Node `util.ciBotCommand` semantics.
+    """
+    text = ci_content_text(chat_item)
+    if not text:
+        return None
+    text = text.strip()
+    m = _BOT_COMMAND_RE.match(text)
+    if not m:
+        return None
+    return m.group(1), m.group(2).strip()
+
+
+def reaction_text(reaction: T.ACIReaction) -> str:
+    """Format an `ACIReaction` as the emoji character or tag string."""
+    r = reaction["chatReaction"]["reaction"]  # type: ignore[index]
+    if r["type"] == "emoji":
+        return r["emoji"]  # type: ignore[index]
+    return r.get("tag", "")  # type: ignore[union-attr]

simplex_chat-6.5.1.dist-info/METADATA

@@ -0,0 +1,98 @@
+Metadata-Version: 2.4
+Name: simplex-chat
+Version: 6.5.1
+Summary: SimpleX Chat Python library for chat bots
+Project-URL: Homepage, https://github.com/simplex-chat/simplex-chat/tree/stable/packages/simplex-chat-python
+Project-URL: Issues, https://github.com/simplex-chat/simplex-chat/issues
+Author: SimpleX Chat
+License-Expression: AGPL-3.0-only
+License-File: LICENSE
+Keywords: bots,chat,messenger,privacy,security,simplex
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: GNU Affero General Public License v3
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Communications :: Chat
+Requires-Python: >=3.11
+Provides-Extra: dev
+Requires-Dist: pyright>=1.1.380; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Provides-Extra: test
+Requires-Dist: pytest-asyncio>=0.23; extra == 'test'
+Requires-Dist: pytest>=8; extra == 'test'
+Description-Content-Type: text/markdown
+
+# SimpleX Chat Python library
+
+Python 3.11+ client for [SimpleX Chat](https://simplex.chat) bots. Equivalent to the [Node.js library](https://www.npmjs.com/package/simplex-chat).
+
+## Install
+
+```bash
+pip install simplex-chat
+```
+
+The native `libsimplex` is downloaded lazily on first use. To pre-fetch:
+
+```bash
+python -m simplex_chat install                     # sqlite (default)
+python -m simplex_chat install --backend postgres  # linux-x86_64 only
+```
+
+## Quick start
+
+```python
+import re
+from simplex_chat import Bot, BotProfile, Message, SqliteDb, TextMessage
+
+bot = Bot(
+    profile=BotProfile(display_name="Squaring bot"),
+    db=SqliteDb(file_prefix="./squaring_bot"),
+    welcome="Send me a number, I'll square it.",
+)
+
+@bot.on_message(content_type="text", text=re.compile(r"^-?\d+(\.\d+)?$"))
+async def square(msg: TextMessage) -> None:
+    n = float(msg.text or "0")
+    await msg.reply(f"{n} * {n} = {n * n}")
+
+@bot.on_message(content_type="text")
+async def fallback(msg: Message) -> None:
+    await msg.reply("Send me a number, like 7 or 3.14.")
+
+if __name__ == "__main__":
+    bot.run()
+```
+
+`bot.run()` blocks. The connection address is logged on startup — paste it into a SimpleX client to talk to the bot. `Ctrl+C` to stop.
+
+Three decorators: `@bot.on_message(...)`, `@bot.on_command(name)`, `@bot.on_event(tag)`. Message handlers are first-match-wins in registration order, so register specific filters first and catch-alls last.
+
+See [`examples/squaring_bot.py`](./examples/squaring_bot.py) for the full example.
+
+## Development
+
+```bash
+uv venv && source .venv/bin/activate
+uv pip install -e '.[dev]'
+ruff check && pyright && pytest tests/
+```
+
+Wire types under `src/simplex_chat/types/_*.py` are generated. Regenerate with `cabal test simplex-chat-test --test-options='--match Python'`.
+
+## Release
+
+Manual for now. Bump `_version.py:__version__`, build a wheel, upload to PyPI:
+
+```bash
+uv build --wheel
+uv publish --token "$PYPI_TOKEN"
+```
+
+## License
+
+[AGPL-3.0](./LICENSE)

simplex_chat-6.5.1.dist-info/RECORD

@@ -0,0 +1,19 @@
+simplex_chat/__init__.py,sha256=FezBxC3pazBkSFdUT1b3UkWY1LqI7kboJYT3402djI8,1226
+simplex_chat/__main__.py,sha256=LtJshOx8sXoRbHJdPd2zmDruBuZkQ7l4JqQ2IENVxZs,1097
+simplex_chat/_native.py,sha256=cjMxOTpOGkiF_tWSroSHsUUcq39XnAJlw6AslLWOlJg,9721
+simplex_chat/_version.py,sha256=G_nG42RX9kJkzCxAmKIH4lRZ39FaiT0VdZ1KLx_nCj8,410
+simplex_chat/api.py,sha256=sklZfJCFlKXSYJetu6CE_szSxU8M_fwY9ZvPxxnM4gE,28234
+simplex_chat/bot.py,sha256=yWyTCQAmO7DxBZIEDzPC4m0FonQqPhD2YUdWTxAQEzE,27306
+simplex_chat/core.py,sha256=eLwiPIlrA1bHKEHRxQie26k_LSRKtnJTn6s-hpAK-h0,7091
+simplex_chat/filters.py,sha256=iYSE9a0THMf53dGoi0QJqQSHBgXkImeMWGg98Nuq9d8,1610
+simplex_chat/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+simplex_chat/util.py,sha256=y3pSzrr4dhDR0s5xX6UdD5b3K0HQp4cQ06HnOcCVOI8,5029
+simplex_chat/types/__init__.py,sha256=zSqRDg53agVD6TY2fkzM3XeK7YY9yujv3e03_cay2Jo,580
+simplex_chat/types/_commands.py,sha256=qKSGkqqfatjGPp0-21EoEVO6XM6CObl6OreQH0XS2ag,22068
+simplex_chat/types/_events.py,sha256=HT4uxItdYLjcASEuKPQaZUpwmC3O2lziW3ZDBUCV_Cg,10959
+simplex_chat/types/_responses.py,sha256=iUpZ8HHW_BOXJWVXMdYWs83yRsHS2AgY0xvHge2YINU,10186
+simplex_chat/types/_types.py,sha256=_f3beWqpIwUkCwRFByNfYhKOB3AKpr1fuGDHOVXU6s4,103439
+simplex_chat-6.5.1.dist-info/METADATA,sha256=6tUSEbC7rbp114U6vUU0xOsSxmao_vN7hdUr5HNcXqI,3170
+simplex_chat-6.5.1.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+simplex_chat-6.5.1.dist-info/licenses/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
+simplex_chat-6.5.1.dist-info/RECORD,,

simplex_chat-6.5.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any