matrix-python 1.4.1a0__py3-none-any.whl → 1.4.3a0__py3-none-any.whl

matrix/__init__.py

@@ -15,6 +15,7 @@ from .command import Command
 from .help import HelpCommand
 from .checks import cooldown
 from .room import Room
+from .message import Message
 from .extension import Extension
 
 __all__ = [
@@ -27,5 +28,6 @@ __all__ = [
     "HelpCommand",
     "cooldown",
     "Room",
+    "Message",
     "Extension",
 ]

matrix/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '1.4.1a0'
-__version_tuple__ = version_tuple = (1, 4, 1, 'a0')
+__version__ = version = '1.4.3a0'
+__version_tuple__ = version_tuple = (1, 4, 3, 'a0')
 
 __commit_id__ = commit_id = None

matrix/bot.py

@@ -28,29 +28,34 @@ class Bot(Registry):
     """
 
     def __init__(
-        self, *, config: Union[Config, str], help: Optional[HelpCommand] = None
+        self,
+        *,
+        help_: Optional[HelpCommand] = None,
     ) -> None:
-        if isinstance(config, Config):
-            self.config = config
-        elif isinstance(config, str):
-            self.config = Config(config_path=config)
-        else:
-            raise TypeError("config must be a Config instance or a config file path")
+        super().__init__(self.__class__.__name__)
 
-        super().__init__(self.__class__.__name__, prefix=self.config.prefix)
-
-        self.client: AsyncClient = AsyncClient(self.config.homeserver)
+        self._config: Config | None = None
+        self._client: AsyncClient | None = None
+        self._help: HelpCommand | None = help_
         self.extensions: dict[str, Extension] = {}
         self.scheduler: Scheduler = Scheduler()
         self.log: logging.Logger = logging.getLogger(__name__)
+        self.start_at: float | None = None
 
-        self.start_at: float | None = None  # unix timestamp
+    @property
+    def client(self) -> AsyncClient:
+        assert self._client is not None, "Bot has not been started."
+        return self._client
 
-        self.help: HelpCommand = help or DefaultHelpCommand(prefix=self.prefix)
-        self.register_command(self.help)
+    @property
+    def config(self) -> Config:
+        assert self._config is not None, "Bot has not been started."
+        return self._config
 
-        self.client.add_event_callback(self._on_matrix_event, Event)
-        self._auto_register_events()
+    @property
+    def help(self) -> HelpCommand:
+        assert self._help is not None, "Bot has not been started."
+        return self._help
 
     def _auto_register_events(self) -> None:
         for attr in dir(self):
@@ -192,7 +197,26 @@ class Bot(Registry):
 
     # ENTRYPOINT
 
-    def start(self) -> None:
+    def _load_config(self, config: Config | str) -> None:
+        if self._config is not None:
+            raise RuntimeError("Config is already loaded.")
+
+        if isinstance(config, str):
+            config = Config(config_path=config)
+        elif not isinstance(config, Config):
+            raise TypeError("config must be a Config instance or a config file path")
+
+        self._config = config
+        self._client = AsyncClient(config.homeserver)
+        self._help = self._help or DefaultHelpCommand()
+
+        self.prefix = config.prefix
+        self.register_command(self.help)
+
+        self.client.add_event_callback(self._on_matrix_event, Event)
+        self._auto_register_events()
+
+    def start(self, *, config: Config | str) -> None:
         """
         Synchronous entry point for running the bot.
 
@@ -201,6 +225,9 @@ class Bot(Registry):
         :func:`asyncio.run`, and ensures the client is closed gracefully
         on interruption.
         """
+        if config is not None:
+            self._load_config(config)
+
         try:
             asyncio.run(self.run())
         except KeyboardInterrupt:
@@ -235,10 +262,10 @@ class Bot(Registry):
 
     # MATRIX EVENTS
 
-    async def on_message(self, room: MatrixRoom, event: Event) -> None:
+    async def on_message(self, room: Room, event: Event) -> None:
         await self._process_commands(room, event)
 
-    async def _on_matrix_event(self, room: MatrixRoom, event: Event) -> None:
+    async def _on_matrix_event(self, matrix_room: MatrixRoom, event: Event) -> None:
         # ignore bot events
         if event.sender == self.client.user:
             return
@@ -248,6 +275,7 @@ class Bot(Registry):
             return
 
         try:
+            room = self.get_room(matrix_room.room_id)
             await self._dispatch_matrix_event(room, event)
         except Exception as error:
             await self._on_error(error)
@@ -257,14 +285,14 @@ class Bot(Registry):
         for handler in self._hook_handlers.get(event_name, []):
             await handler(*args, **kwargs)
 
-    async def _dispatch_matrix_event(self, room: MatrixRoom, event: Event) -> None:
+    async def _dispatch_matrix_event(self, room: Room, event: Event) -> None:
         """Fire all listeners registered for a named matrix event."""
         for event_type, funcs in self._event_handlers.items():
             if isinstance(event, event_type):
                 for func in funcs:
                     await func(room, event)
 
-    async def _process_commands(self, room: MatrixRoom, event: Event) -> None:
+    async def _process_commands(self, room: Room, event: Event) -> None:
         """Parse and execute commands"""
         ctx = await self._build_context(room, event)
 
@@ -276,7 +304,7 @@ class Bot(Registry):
             await self._on_command(ctx)
             await ctx.command(ctx)
 
-    async def _build_context(self, matrix_room: MatrixRoom, event: Event) -> Context:
+    async def _build_context(self, matrix_room: Room, event: Event) -> Context:
         room = self.get_room(matrix_room.room_id)
         ctx = Context(bot=self, room=room, event=event)
         prefix = self.prefix or self.config.prefix

matrix/message.py

@@ -1,5 +1,8 @@
-from typing import TYPE_CHECKING
-from nio import AsyncClient
+from typing import TYPE_CHECKING, Self
+
+from nio import AsyncClient, Event
+
+from matrix.types import Reaction
 from matrix.content import ReactionContent, EditContent
 from matrix.errors import MatrixError
 
@@ -10,28 +13,35 @@ if TYPE_CHECKING:
 class Message:
     """Represents a Matrix message with methods to interact with it."""
 
-    def __init__(
-        self, *, room: "Room", event_id: str, body: str | None, client: AsyncClient
-    ) -> None:
+    def __init__(self, *, room: "Room", event: Event, client: AsyncClient) -> None:
         self._room = room
-        self._event_id = event_id
-        self._body = body
+        self._matrix_event: Event = event
         self._client = client
 
+        self._body = getattr(self._matrix_event, "body", None)
+
+    def __repr__(self) -> str:
+        return f"<Message id={self.event_id!r} body={self.body!r}>"
+
     @property
     def room(self) -> "Room":
         """The room this message was sent in."""
         return self._room
 
     @property
-    def id(self) -> str:
-        """The event ID of this message."""
-        return self._event_id
+    def event(self) -> Event:
+        """The matrix event of this message"""
+        return self._matrix_event
+
+    @property
+    def client(self) -> AsyncClient:
+        """The Matrix client."""
+        return self._client
 
     @property
     def event_id(self) -> str:
-        """The event ID of this message (alias for id)."""
-        return self._event_id
+        """The event ID of this message."""
+        return str(self._matrix_event.event_id)
 
     @property
     def body(self) -> str | None:
@@ -39,9 +49,41 @@ class Message:
         return self._body
 
     @property
-    def client(self) -> AsyncClient:
-        """The Matrix client."""
-        return self._client
+    def key(self) -> str | None:
+        """The key of this message."""
+        return getattr(self._matrix_event, "key", None)
+
+    async def fetch_reactions(self) -> list[Reaction]:
+        """Fetch all reactions for this message.
+
+        Returns a dict mapping emoji to a list of sender IDs who reacted with it.
+
+        ## Example
+        ```python
+            @bot.command()
+            async def reactions(ctx: Context):
+                reactions = await ctx.message.fetch_reactions()
+
+                for emoji, senders in reactions.items():
+                    await ctx.reply(f"{emoji}: {len(senders)} reaction(s)")
+        ```
+        """
+        raw: dict[str, list[str]] = {}
+
+        try:
+            async for event in self.client.room_get_event_relations(
+                room_id=self.room.room_id,
+                event_id=self.event_id,
+            ):
+                emoji = getattr(event, "key", None)
+                sender = getattr(event, "sender", None)
+
+                if emoji and sender:
+                    raw.setdefault(emoji, []).append(sender)
+        except Exception as e:
+            raise MatrixError(f"Failed to fetch reactions: {e}")
+
+        return [Reaction(key=emoji, senders=senders) for emoji, senders in raw.items()]
 
     async def reply(self, body: str) -> "Message":
         """Reply to this message.
@@ -57,7 +99,7 @@ class Message:
         ```
         """
         try:
-            return await self.room.send_text(content=body, reply_to=self.id)
+            return await self.room.send_text(content=body, reply_to=self.event_id)
         except Exception as e:
             raise MatrixError(f"Failed to send reply: {e}")
 
@@ -72,7 +114,7 @@ class Message:
             await msg.react("👍")
         ```
         """
-        content = ReactionContent(event_id=self.id, emoji=emoji)
+        content = ReactionContent(event_id=self.event_id, emoji=emoji)
 
         try:
             await self.client.room_send(
@@ -95,7 +137,7 @@ class Message:
             await msg.edit("Hello world!")
         ```
         """
-        content = EditContent(new_body, original_event_id=self.id)
+        content = EditContent(new_body, original_event_id=self.event_id)
 
         try:
             await self.client.room_send(
@@ -122,10 +164,7 @@ class Message:
         try:
             await self.client.room_redact(
                 room_id=self.room.room_id,
-                event_id=self.id,
+                event_id=self.event_id,
             )
         except Exception as e:
             raise MatrixError(f"Failed to delete message: {e}")
-
-    def __repr__(self) -> str:
-        return f"<Message id={self.id!r} body={self.body!r}>"

matrix/room.py

@@ -1,6 +1,6 @@
 from typing import Any
 
-from nio import AsyncClient, MatrixRoom
+from nio import AsyncClient, MatrixRoom, Event
 
 from matrix.errors import MatrixError
 from matrix.message import Message
@@ -25,6 +25,22 @@ class Room:
         self._matrix_room: MatrixRoom = matrix_room
         self._client: AsyncClient = client
 
+    def __getattr__(self, name: str) -> Any:
+        """
+        Fallback to MatrixRoom for attributes not explicitly defined.
+
+        This allows access to any MatrixRoom attribute not wrapped by this class.
+        See matrix-nio's MatrixRoom documentation for available attributes.
+
+        https://matrix-nio.readthedocs.io/en/latest/nio.html#nio.rooms.MatrixRoom
+        """
+        try:
+            return getattr(self._matrix_room, name)
+        except AttributeError:
+            raise AttributeError(
+                f"'{type(self).__name__}' object has no attribute '{name}'"
+            ) from None
+
     @property
     def matrix_room(self) -> MatrixRoom:
         """Access to underlying MatrixRoom object."""
@@ -65,22 +81,6 @@ class Room:
         """Whether the room is encrypted."""
         return self._matrix_room.encrypted  # type: ignore[no-any-return]
 
-    def __getattr__(self, name: str) -> Any:
-        """
-        Fallback to MatrixRoom for attributes not explicitly defined.
-
-        This allows access to any MatrixRoom attribute not wrapped by this class.
-        See matrix-nio's MatrixRoom documentation for available attributes.
-
-        https://matrix-nio.readthedocs.io/en/latest/nio.html#nio.rooms.MatrixRoom
-        """
-        try:
-            return getattr(self._matrix_room, name)
-        except AttributeError:
-            raise AttributeError(
-                f"'{type(self).__name__}' object has no attribute '{name}'"
-            ) from None
-
     async def send(
         self,
         content: str | None = None,
@@ -319,16 +319,50 @@ class Room:
                 message_type="m.room.message",
                 content=payload.build(),
             )
+            event = await self.fetch_event(resp.event_id)
 
             return Message(
                 room=self,
-                event_id=resp.event_id,
-                body=getattr(payload, "body", None),
+                event=event,
                 client=self.client,
             )
         except Exception as e:
             raise MatrixError(f"Failed to send message: {e}")
 
+    async def fetch_event(self, event_id: str) -> Event:
+        """Fetch a Matrix event by its ID.
+
+        ## Example
+        ```python
+            event = await room.fetch_event("$event_id:matrix.org")
+            print(event.sender)
+        ```
+        """
+        try:
+            response = await self.client.room_get_event(
+                room_id=self.room_id,
+                event_id=event_id,
+            )
+            return response.event
+        except Exception as e:
+            raise MatrixError(f"Failed to get event: {e}")
+
+    async def fetch_message(self, event_id: str) -> Message:
+        """Fetch a Message by its event ID.
+
+        ## Example
+        ```python
+            message = await room.fetch_message("$event_id:matrix.org")
+            message.reply("hello world")
+        ```
+        """
+        event = await self.fetch_event(event_id)
+        return Message(
+            room=self,
+            event=event,
+            client=self.client,
+        )
+
     async def invite_user(self, user_id: str) -> None:
         """Invite a user to the room.
 

matrix/types.py

@@ -24,3 +24,9 @@ class Video(File):
     width: int = 0
     height: int = 0
     duration: int = 0
+
+
+@dataclass
+class Reaction:
+    key: str
+    senders: list[str]

{matrix_python-1.4.1a0.dist-info → matrix_python-1.4.3a0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: matrix-python
-Version: 1.4.1a0
+Version: 1.4.3a0
 Summary: An easy-to-use Matrix bot framework designed for quick development and minimal setup
 Author: Simon Roy,  Chris Dedman Rollet 
 Maintainer-email: Code Society Lab <admin@codesociety.xyz>
@@ -718,6 +718,7 @@ decorator-based API similar to popular event-driven frameworks, allowing
 developers to focus on behavior rather than boilerplate.
 
 #### Key Features
+
 - Minimal setup, easy to extend
 - Event-driven API using async/await
 - Clean command registration
@@ -727,6 +728,7 @@ developers to focus on behavior rather than boilerplate.
 # Quickstart
 
 **Requirements**
+
 - Python 3.10+
 
 ```
@@ -734,38 +736,45 @@ pip install matrix-python
 ```
 
 If you plan on contributing to matrix.py, we recommend to install the development libraries:
+
 ```
 pip install -e .[dev]
 ```
 
-*Note*: It is recommended to use a [virtual environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/) when installing python packages.
-
+*Note*: It is recommended to use
+a [virtual environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/)
+when installing python packages.
 
 ```python
 from matrix import Bot, Context
 
-bot = Bot(config="config.yml")
+bot = Bot()
 
 
 @bot.command("ping")
 async def ping(ctx: Context):
-    await ctx.send("Pong!")
+    await ctx.reply("Pong!")
 
 
-bot.start()
+bot.start(config="config.yml")
 ```
 
 [Documentation](https://github.com/Code-Society-Lab/matrixpy/wiki) - [Examples](https://github.com/Code-Society-Lab/matrixpy/tree/main/examples)
 
 # Contributing
-We welcome everyone to contribute! 
+
+We welcome everyone to contribute!
 
 Whether it's fixing bugs, suggesting features, or improving the docs - every bit helps.
+
 - Submit an issue
 - Open a pull request
-- Or just hop into our [Matrix](https://matrix.to/#/%23codesociety:matrix.org) or [Discord](https://discord.gg/code-society-823178343943897088) server and say hi!
+- Or just hop into our [Matrix](https://matrix.to/#/%23codesociety:matrix.org)
+  or [Discord](https://discord.gg/code-society-823178343943897088) server and say hi!
 
-If you intend to contribute, please read the [CONTRIBUTING.md](./CONTRIBUTING.md) first. Additionally, **every contributor** is expected to follow the [code of conduct](./CODE_OF_CONDUCT.md).
+If you intend to contribute, please read the [CONTRIBUTING.md](./CONTRIBUTING.md) first. Additionally, **every
+contributor** is expected to follow the [code of conduct](./CODE_OF_CONDUCT.md).
 
 # License
+
 matrix.py is released under [GPL-3.0](https://opensource.org/license/gpl-3-0)

{matrix_python-1.4.1a0.dist-info → matrix_python-1.4.3a0.dist-info}/RECORD

@@ -1,6 +1,6 @@
-matrix/__init__.py,sha256=Wo5-bisd2CLwH5p48d2AwqaCeYtGi78GWeMkvJRuaTk,684
-matrix/_version.py,sha256=hLbk0OM_vBZ8bjp25JufFvnWCZ7E5n03qPCWDS3CuPc,528
-matrix/bot.py,sha256=FqM4uRGFk7lEgJXgmOFDUdmuEb-Oa8CYzJh1X7rjebk,10258
+matrix/__init__.py,sha256=g8yEFjELnnwlvOKns-Ug6LgOezkjAFZ-Opt7esbBHKg,728
+matrix/_version.py,sha256=plMXow2DL2g2_z2fF5kLXciPIcp_Vktf4HB8CNoV650,528
+matrix/bot.py,sha256=I6QrK3Fqf-itwv1ZiLSLZ4eeZSlURbC4Mi7eQ2bxzRc,11042
 matrix/checks.py,sha256=F_7432_OcFO-im4fRAj62MUsyv1mXywT4OsGC_7xbBQ,486
 matrix/command.py,sha256=GrP3WsT07sKehGX7PHfnT7gRX22d99877VPd0X2ViEw,10514
 matrix/config.py,sha256=wPLfcHGpSapkBqbZIuI7zBdxh52OHTD8cQS0WqQkMeU,2388
@@ -9,16 +9,16 @@ matrix/context.py,sha256=-CbxY-LtK9-jgHERhvJH73B3SpO-Uk5ty0j1TMKfzuI,4032
 matrix/errors.py,sha256=_9WtZ2D0RxYCQTwItImUEjfD1qjvkQWPn5ZG3VUsUn4,1627
 matrix/extension.py,sha256=7zBTlqVC-9F8RY60Loo65YgdVoJa5QDFeiz8nHjuebo,1883
 matrix/group.py,sha256=TRIX7PE3lcB2ZWu3xY2W2OAmE_a8-i2zHNBYnX5uj28,3691
-matrix/message.py,sha256=7L9M354VM0KWmzL0032-Nq_2wBrSvbqy7KixMXocP-Q,3752
+matrix/message.py,sha256=w6pu86goylxdrX5fgXPUMB_tW0bOFIk6tKy6qkXTjl4,5136
 matrix/protocols.py,sha256=UC7F8T2pPffBMf_QiANXtga50rznSfUsJ7pxpKhQGPQ,159
 matrix/registry.py,sha256=jxXg_f_pVl6nuwLdVOIjWJ9Yl9hDJSLwoChnnr3ztNs,12753
-matrix/room.py,sha256=uNcUrqHhHK98fCxnVZUwLk1nR-4No0Wlx-RG-J9_lQA,13051
+matrix/room.py,sha256=PBuMWQo8mKy2d2XIeMbBlVBTnnqZjOPPGpKLp4K1AVM,14038
 matrix/scheduler.py,sha256=EXsL9i8IDXhcpdW8lti0BR5XcIgkmud4iwOPaqcE9Gw,1727
-matrix/types.py,sha256=FHnSYmf5yB99kR9ZCeXLAqNcbWkt0zG75s_TD2pIp2Q,319
+matrix/types.py,sha256=UFjC7p8RAf7piEPvp2X3NuWdqBwkM9Yc3He7KWb9icc,384
 matrix/help/__init__.py,sha256=1u7V7T_-VgYDeQCTXsc4y8Fo-8gJhOqYJq2U3cUjMWg,168
 matrix/help/help_command.py,sha256=xCLmKklw74LEMjbUfgQR9eaPMFvi3sPtDw2n2pnAnVQ,12800
 matrix/help/pagination.py,sha256=sJk0wC46sFHf7xl7WsGRAUc4FC7b9hPqmwQDmvcjwgM,2717
-matrix_python-1.4.1a0.dist-info/METADATA,sha256=DOdiTiUth4zsbzKq_PtFR-L6CYFaCdtbkSq5VVED0Uw,44534
-matrix_python-1.4.1a0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-matrix_python-1.4.1a0.dist-info/top_level.txt,sha256=BvHVM9c7-5SLzg-1OCRpHKgqAubWhRN1e38e6coHs-g,7
-matrix_python-1.4.1a0.dist-info/RECORD,,
+matrix_python-1.4.3a0.dist-info/METADATA,sha256=eTHsGOLbn83lgCFcQgvu-j2JjCk17dYRgxukSzhYOwE,44541
+matrix_python-1.4.3a0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+matrix_python-1.4.3a0.dist-info/top_level.txt,sha256=BvHVM9c7-5SLzg-1OCRpHKgqAubWhRN1e38e6coHs-g,7
+matrix_python-1.4.3a0.dist-info/RECORD,,