Skip to content

Python SDKs: make the mautrix sample type-check #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
melvincarvalho merged 1 commit into from
Oct 18, 2026
Merged

Python SDKs: make the mautrix sample type-check #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/sdks/matrix-python-sdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ mautrix-python is the library under [maubot](../bots/maubot). Most mautrix bridg

### A minimal client

Checked against mautrix 0.21.1 by constructing the client and registering the handler, without network access. Create the `Client` inside a running event loop.
Checked against mautrix 0.21.1 with pyright (no errors), and by constructing the client and registering the handler without network access. Create the `Client` inside a running event loop. The `@client.on(...)` decorator also works at runtime, but its type hints make pyright report an error, so this sample uses `add_event_handler`.

```python
import asyncio
Expand All @@ -144,11 +144,12 @@ async def main() -> None:
client.ignore_initial_sync = True # don't replay history on startup
client.ignore_first_sync = True

@client.on(EventType.ROOM_MESSAGE)
async def handler(evt: MessageEvent) -> None:
if evt.sender != client.mxid and evt.content.body == "!ping":
await client.send_notice(evt.room_id, "pong")

client.add_event_handler(EventType.ROOM_MESSAGE, handler)

await client.start(None) # runs until stopped


Expand Down
Loading