matrix-python 1.4.8a0__py3-none-any.whl → 1.4.9a0__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.8a0'
-__version_tuple__ = version_tuple = (1, 4, 8, 'a0')
+__version__ = version = '1.4.9a0'
+__version_tuple__ = version_tuple = (1, 4, 9, 'a0')
 
 __commit_id__ = commit_id = None

matrix/extension.py

@@ -1,21 +1,31 @@
 import inspect
 import logging
-from typing import Callable, Optional
+from typing import Callable
 
 from matrix.protocols import BotLike
 from matrix.registry import Registry
+from matrix.config import Config
 from matrix.room import Room
 
 logger = logging.getLogger(__name__)
 
 
 class Extension(Registry):
-    def __init__(self, name: str, prefix: Optional[str] = None) -> None:
+    def __init__(self, name: str, prefix: str | None = None) -> None:
         super().__init__(name, prefix=prefix)
 
-        self.bot: Optional[BotLike] = None
-        self._on_load: Optional[Callable] = None
-        self._on_unload: Optional[Callable] = None
+        self._bot: BotLike | None = None
+        self._on_load: Callable | None = None
+        self._on_unload: Callable | None = None
+
+    @property
+    def bot(self) -> BotLike:
+        assert self._bot, "Extension is not loaded"
+        return self._bot
+
+    @property
+    def config(self) -> Config:
+        return self.bot.config
 
     def get_room(self, room_id: str) -> Room | None:
         """Retrieve a `Room` instance by its Matrix room ID.
@@ -31,12 +41,10 @@ class Extension(Registry):
             print(room.name)
         ```
         """
-        if self.bot is None:
-            raise RuntimeError("Extension is not loaded")
         return self.bot.get_room(room_id)
 
     def load(self, bot: BotLike) -> None:
-        self.bot = bot
+        self._bot = bot
 
         if self._on_load:
             self._on_load()
@@ -59,7 +67,7 @@ class Extension(Registry):
         return func
 
     def unload(self) -> None:
-        self.bot = None
+        self._bot = None
 
         if self._on_unload:
             self._on_unload()

matrix/protocols.py

@@ -1,9 +1,13 @@
 from typing import Protocol
 
+from matrix.config import Config
 from matrix.room import Room
 
 
 class BotLike(Protocol):
     prefix: str | None
 
+    @property
+    def config(self) -> Config: ...
+
     def get_room(self, room_id: str) -> Room | None: ...

matrix/registry.py

@@ -2,7 +2,20 @@ import inspect
 import logging
 
 from collections import defaultdict
-from typing import Any, Callable, Coroutine, Optional, Type, Union, Dict, List
+from typing import (
+    TypeVar,
+    Any,
+    Callable,
+    Coroutine,
+    Literal,
+    Optional,
+    Type,
+    Union,
+    Dict,
+    List,
+    cast,
+    overload,
+)
 
 from nio import (
     Event,
@@ -25,6 +38,8 @@ GroupCallable = Callable[[Callable[..., Coroutine[Any, Any, Any]]], Group]
 ErrorCallback = Callable[[Exception], Coroutine]
 CommandErrorCallback = Callable[[Context, Exception], Coroutine[Any, Any, Any]]
 
+F = TypeVar("F", ErrorCallback, CommandErrorCallback)
+
 
 class Registry:
     """
@@ -355,43 +370,91 @@ class Registry:
 
         return wrapper
 
+    @overload
     def error(
-        self, exception: Optional[type[Exception]] = None
-    ) -> Callable[[ErrorCallback], ErrorCallback]:
+        self,
+        exception: Optional[type[Exception]] = None,
+        *,
+        context: Literal[True],
+    ) -> Callable[[CommandErrorCallback], CommandErrorCallback]: ...
+
+    @overload
+    def error(
+        self,
+        exception: Optional[type[Exception]] = None,
+        *,
+        context: Literal[False] = ...,
+    ) -> Callable[[ErrorCallback], ErrorCallback]: ...
+
+    def error(
+        self,
+        exception: Optional[type[Exception]] = None,
+        *,
+        context: bool = False,
+    ) -> Union[
+        Callable[[ErrorCallback], ErrorCallback],
+        Callable[[CommandErrorCallback], CommandErrorCallback],
+    ]:
         """Decorator to register an error handler.
 
         If an exception type is provided, the handler is only invoked for
         that specific exception. If omitted, the handler acts as a generic
         fallback for any unhandled error.
 
+        Set ``context=True`` to receive the command context alongside the error,
+        useful for command-specific errors where you want to reply to the user.
+
         ## Example
 
         ```python
         @bot.error(ValueError)
         async def on_value_error(error):
-            await room.send(f"Bad value: {error}")
+            pass
 
         @bot.error()
         async def on_any_error(error):
-            await room.send(f"Something went wrong: {error}")
+            pass
+
+        @bot.error(CommandNotFoundError, context=True)
+        async def on_command_not_found(ctx, error):
+            await ctx.reply("Command not found!")
         ```
         """
 
-        if not exception:
-            exception = Exception
-
-        def wrapper(func: ErrorCallback) -> ErrorCallback:
+        def wrapper(
+            func: F,
+        ) -> F:
             if not inspect.iscoroutinefunction(func):
                 raise TypeError("Error handlers must be coroutines")
 
-            self._error_handlers[exception] = func
+            if context:
+                self._register_command_error(
+                    cast(CommandErrorCallback, func), exception
+                )
+            else:
+                self._register_error(cast(ErrorCallback, func), exception)
 
             logger.debug(
                 "registered error handler '%s' on %s",
                 func.__name__,
                 type(self).__name__,
             )
-
             return func
 
         return wrapper
+
+    def _register_error(
+        self, func: ErrorCallback, exception: Optional[type[Exception]] = None
+    ) -> None:
+        if not exception:
+            exception = Exception
+        self._error_handlers[exception] = func
+
+    def _register_command_error(
+        self,
+        func: CommandErrorCallback,
+        exception: Optional[type[Exception]] = None,
+    ) -> None:
+        if not exception:
+            exception = Exception
+        self._command_error_handlers[exception] = func

{matrix_python-1.4.8a0.dist-info → matrix_python-1.4.9a0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: matrix-python
-Version: 1.4.8a0
+Version: 1.4.9a0
 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.8a0.dist-info → matrix_python-1.4.9a0.dist-info}/RECORD

@@ -1,5 +1,5 @@
 matrix/__init__.py,sha256=g8yEFjELnnwlvOKns-Ug6LgOezkjAFZ-Opt7esbBHKg,728
-matrix/_version.py,sha256=Sp0Aavn8Gz-jkQehzIA2xsa-Il-CUVey1i9m5oSJ344,528
+matrix/_version.py,sha256=IJ3HlP4Svp0RN0mpe6HhSO9QSg0hWZBUdUwTFQyE4bY,528
 matrix/bot.py,sha256=tbcn1Ra025I9plM-gf0NpzPKSTBlYe0_L8_RLO8w9GM,11984
 matrix/checks.py,sha256=F_7432_OcFO-im4fRAj62MUsyv1mXywT4OsGC_7xbBQ,486
 matrix/command.py,sha256=GrP3WsT07sKehGX7PHfnT7gRX22d99877VPd0X2ViEw,10514
@@ -7,19 +7,19 @@ matrix/config.py,sha256=JW_BBs-msIhtv1AGebZumLsx4td-Gp-NZaNYPJxRsEo,3680
 matrix/content.py,sha256=z5_E2rTvHsODE52OiDkhDHNQAryx5NLhyHjBb65Xe-U,3853
 matrix/context.py,sha256=-CbxY-LtK9-jgHERhvJH73B3SpO-Uk5ty0j1TMKfzuI,4032
 matrix/errors.py,sha256=HKGb5NUeFuZvieXgpLlVSmUxK4jpA0ODuiPQqQlbQTE,1676
-matrix/extension.py,sha256=RbCx58CdRXF8kGUgS-ec1aZdd-K5hQedhCCQ0-YR4Vg,2272
+matrix/extension.py,sha256=5f6pW_6D8wwN5qKhnQRkCWWDkkQw9t47j5XRNZNsyGQ,2399
 matrix/group.py,sha256=TRIX7PE3lcB2ZWu3xY2W2OAmE_a8-i2zHNBYnX5uj28,3691
 matrix/message.py,sha256=w6pu86goylxdrX5fgXPUMB_tW0bOFIk6tKy6qkXTjl4,5136
-matrix/protocols.py,sha256=nFb4tLanwtrKWoIhZ96xMwXPjD3RF5ITca_yXtakXC4,166
+matrix/protocols.py,sha256=pIkHL4yuenvxh-gFhRPudCHJcfMBRxq2lUL5S5sPxpM,250
 matrix/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-matrix/registry.py,sha256=PgdmbBADS-yqdFdj9x3QSsVfefx8Li848CU_UBbqCLQ,12646
+matrix/registry.py,sha256=OiEWaO66k4QOnOPCaXL5Ys-_TnVioI4q5ulyRP_fGS4,14202
 matrix/room.py,sha256=PBuMWQo8mKy2d2XIeMbBlVBTnnqZjOPPGpKLp4K1AVM,14038
 matrix/scheduler.py,sha256=EXsL9i8IDXhcpdW8lti0BR5XcIgkmud4iwOPaqcE9Gw,1727
 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.8a0.dist-info/METADATA,sha256=Cw_QAKOVIvymFvEELdhYf72O0UkQOSk21KMpc01KAOY,5421
-matrix_python-1.4.8a0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-matrix_python-1.4.8a0.dist-info/top_level.txt,sha256=BvHVM9c7-5SLzg-1OCRpHKgqAubWhRN1e38e6coHs-g,7
-matrix_python-1.4.8a0.dist-info/RECORD,,
+matrix_python-1.4.9a0.dist-info/METADATA,sha256=brnqebUw6xsHqIDXvyCZuyMVWzgGKy70BSjFoM2NNm8,5421
+matrix_python-1.4.9a0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+matrix_python-1.4.9a0.dist-info/top_level.txt,sha256=BvHVM9c7-5SLzg-1OCRpHKgqAubWhRN1e38e6coHs-g,7
+matrix_python-1.4.9a0.dist-info/RECORD,,