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

matrix/_version.py

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

matrix/bot.py

@@ -3,7 +3,7 @@ import inspect
 import asyncio
 import logging
 
-from typing import Union, Optional, Any
+from typing import Optional, Any
 
 from nio import AsyncClient, Event, MatrixRoom
 
@@ -15,7 +15,12 @@ from .extension import Extension
 from .registry import Registry
 from .help import HelpCommand, DefaultHelpCommand
 from .scheduler import Scheduler
-from .errors import AlreadyRegisteredError, CommandNotFoundError, CheckError
+from .errors import (
+    AlreadyRegisteredError,
+    CommandNotFoundError,
+    CheckError,
+    RoomNotFoundError,
+)
 
 
 class Bot(Registry):
@@ -36,7 +41,9 @@ class Bot(Registry):
 
         self._config: Config | None = None
         self._client: AsyncClient | None = None
+        self._synced: asyncio.Event = asyncio.Event()
         self._help: HelpCommand | None = help_
+
         self.extensions: dict[str, Extension] = {}
         self.scheduler: Scheduler = Scheduler()
         self.log: logging.Logger = logging.getLogger(__name__)
@@ -75,10 +82,23 @@ class Bot(Registry):
             except ValueError:
                 continue
 
-    def get_room(self, room_id: str) -> Room:
-        """Retrieve a Room instance based on the room_id."""
-        matrix_room = self.client.rooms[room_id]
-        return Room(matrix_room=matrix_room, client=self.client)
+    def get_room(self, room_id: str) -> Room | None:
+        """Retrieve a `Room` instance by its Matrix room ID.
+
+        Returns the `Room` object corresponding to `room_id` if it exists in
+        the client's known rooms. Returns `None` if the room cannot be found.
+
+        ## Example
+
+        ```python
+        room = bot.get_room("!abc123:matrix.org")
+        if room:
+            print(room.name)
+        ```
+        """
+        if matrix_room := self.client.rooms.get(room_id):
+            return Room(matrix_room=matrix_room, client=self.client)
+        return None
 
     def load_extension(self, extension: Extension) -> None:
         self.log.debug(f"Loading extension: '{extension.name}'")
@@ -255,10 +275,16 @@ class Bot(Registry):
             login_resp = await self.client.login(self.config.password)
             self.log.info("logged in: %s", login_resp)
 
-        self.scheduler.start()
+        sync_task = asyncio.create_task(self.client.sync_forever(timeout=30_000))
 
+        await self._wait_until_synced()
         await self._on_ready()
-        await self.client.sync_forever(timeout=30_000)
+
+        self.scheduler.start()
+        await sync_task
+
+    async def _wait_until_synced(self) -> None:
+        await self._synced.wait()
 
     # MATRIX EVENTS
 
@@ -266,6 +292,9 @@ class Bot(Registry):
         await self._process_commands(room, event)
 
     async def _on_matrix_event(self, matrix_room: MatrixRoom, event: Event) -> None:
+        if not self._synced.is_set():
+            self._synced.set()
+
         # ignore bot events
         if event.sender == self.client.user:
             return
@@ -276,6 +305,10 @@ class Bot(Registry):
 
         try:
             room = self.get_room(matrix_room.room_id)
+
+            if not room:
+                raise RoomNotFoundError(f"Room '{matrix_room.room_id}' not found.")
+
             await self._dispatch_matrix_event(room, event)
         except Exception as error:
             await self._on_error(error)
@@ -306,6 +339,10 @@ class Bot(Registry):
 
     async def _build_context(self, matrix_room: Room, event: Event) -> Context:
         room = self.get_room(matrix_room.room_id)
+
+        if not room:
+            raise RoomNotFoundError(f"Room '{matrix_room.room_id}' not found.")
+
         ctx = Context(bot=self, room=room, event=event)
         prefix = self.prefix or self.config.prefix
 

matrix/errors.py

@@ -13,6 +13,10 @@ class MatrixError(Exception):
     pass
 
 
+class RoomNotFoundError(MatrixError):
+    pass
+
+
 class RegistryError(MatrixError):
     pass
 

matrix/extension.py

@@ -17,7 +17,20 @@ class Extension(Registry):
         self._on_load: Optional[Callable] = None
         self._on_unload: Optional[Callable] = None
 
-    def get_room(self, room_id: str) -> Room:
+    def get_room(self, room_id: str) -> Room | None:
+        """Retrieve a `Room` instance by its Matrix room ID.
+
+        Returns the `Room` object corresponding to `room_id` if it exists in
+        the client's known rooms. Returns `None` if the room cannot be found.
+
+        ## Example
+
+        ```python
+        room = extension.get_room("!abc123:matrix.org")
+        if room:
+            print(room.name)
+        ```
+        """
         if self.bot is None:
             raise RuntimeError("Extension is not loaded")
         return self.bot.get_room(room_id)

matrix/protocols.py

@@ -6,4 +6,4 @@ from matrix.room import Room
 class BotLike(Protocol):
     prefix: str | None
 
-    def get_room(self, room_id: str) -> Room: ...
+    def get_room(self, room_id: str) -> Room | None: ...

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: matrix-python
-Version: 1.4.3a0
+Version: 1.4.4a0
 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>

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

@@ -1,16 +1,16 @@
 matrix/__init__.py,sha256=g8yEFjELnnwlvOKns-Ug6LgOezkjAFZ-Opt7esbBHKg,728
-matrix/_version.py,sha256=plMXow2DL2g2_z2fF5kLXciPIcp_Vktf4HB8CNoV650,528
-matrix/bot.py,sha256=I6QrK3Fqf-itwv1ZiLSLZ4eeZSlURbC4Mi7eQ2bxzRc,11042
+matrix/_version.py,sha256=tcfrwnvkUDHHz8JoKK522ystGqqHOEnmR8F4E8SoWsI,528
+matrix/bot.py,sha256=4gwL2vawLFEREwZD4cEydv6XSXm_SP6pztLD8uwB86M,11944
 matrix/checks.py,sha256=F_7432_OcFO-im4fRAj62MUsyv1mXywT4OsGC_7xbBQ,486
 matrix/command.py,sha256=GrP3WsT07sKehGX7PHfnT7gRX22d99877VPd0X2ViEw,10514
 matrix/config.py,sha256=wPLfcHGpSapkBqbZIuI7zBdxh52OHTD8cQS0WqQkMeU,2388
 matrix/content.py,sha256=z5_E2rTvHsODE52OiDkhDHNQAryx5NLhyHjBb65Xe-U,3853
 matrix/context.py,sha256=-CbxY-LtK9-jgHERhvJH73B3SpO-Uk5ty0j1TMKfzuI,4032
-matrix/errors.py,sha256=_9WtZ2D0RxYCQTwItImUEjfD1qjvkQWPn5ZG3VUsUn4,1627
-matrix/extension.py,sha256=7zBTlqVC-9F8RY60Loo65YgdVoJa5QDFeiz8nHjuebo,1883
+matrix/errors.py,sha256=HKGb5NUeFuZvieXgpLlVSmUxK4jpA0ODuiPQqQlbQTE,1676
+matrix/extension.py,sha256=RbCx58CdRXF8kGUgS-ec1aZdd-K5hQedhCCQ0-YR4Vg,2272
 matrix/group.py,sha256=TRIX7PE3lcB2ZWu3xY2W2OAmE_a8-i2zHNBYnX5uj28,3691
 matrix/message.py,sha256=w6pu86goylxdrX5fgXPUMB_tW0bOFIk6tKy6qkXTjl4,5136
-matrix/protocols.py,sha256=UC7F8T2pPffBMf_QiANXtga50rznSfUsJ7pxpKhQGPQ,159
+matrix/protocols.py,sha256=nFb4tLanwtrKWoIhZ96xMwXPjD3RF5ITca_yXtakXC4,166
 matrix/registry.py,sha256=jxXg_f_pVl6nuwLdVOIjWJ9Yl9hDJSLwoChnnr3ztNs,12753
 matrix/room.py,sha256=PBuMWQo8mKy2d2XIeMbBlVBTnnqZjOPPGpKLp4K1AVM,14038
 matrix/scheduler.py,sha256=EXsL9i8IDXhcpdW8lti0BR5XcIgkmud4iwOPaqcE9Gw,1727
@@ -18,7 +18,7 @@ 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.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,,
+matrix_python-1.4.4a0.dist-info/METADATA,sha256=zswqUmzf_FyaRISg-p2Rqxqocwb9vwHT7Ldr51d4K5A,44541
+matrix_python-1.4.4a0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+matrix_python-1.4.4a0.dist-info/top_level.txt,sha256=BvHVM9c7-5SLzg-1OCRpHKgqAubWhRN1e38e6coHs-g,7
+matrix_python-1.4.4a0.dist-info/RECORD,,