matrix-python 1.4.8a0__tar.gz → 1.4.9a0__tar.gz

{matrix_python-1.4.8a0/matrix_python.egg-info → matrix_python-1.4.9a0}/PKG-INFO

@@ -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 → matrix_python-1.4.9a0}/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 = 'g16bd59854'
+__commit_id__ = commit_id = 'g5f8d673e3'

{matrix_python-1.4.8a0 → matrix_python-1.4.9a0}/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_python-1.4.8a0 → matrix_python-1.4.9a0}/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_python-1.4.8a0 → matrix_python-1.4.9a0}/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 → matrix_python-1.4.9a0/matrix_python.egg-info}/PKG-INFO

@@ -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 → matrix_python-1.4.9a0}/tests/test_extension.py

@@ -3,6 +3,7 @@ import pytest
 from unittest.mock import MagicMock
 from typing import Optional
 
+from matrix.config import Config
 from matrix.extension import Extension
 from matrix.room import Room
 
@@ -10,6 +11,10 @@ from matrix.room import Room
 class MockBot:
     prefix: str = "!"
 
+    @property
+    def config(self) -> Config:
+        return MagicMock(spec=Config)
+
     def __init__(self, room: Optional[Room] = None) -> None:
         self.get_room = MagicMock(return_value=room or MagicMock(spec=Room))
 
@@ -41,7 +46,8 @@ def test_init_with_name_only__expect_prefix_is_none():
 
 
 def test_init__expect_bot_is_none(extension: Extension):
-    assert extension.bot is None
+    with pytest.raises(AssertionError):
+        _ = extension.bot
 
 
 def test_init__expect_on_load_is_none(extension: Extension):
@@ -190,7 +196,8 @@ def test_unload__expect_bot_cleared(extension: Extension, bot: MockBot):
     extension.load(bot)
     extension.unload()
 
-    assert extension.bot is None
+    with pytest.raises(AssertionError):
+        _ = extension.bot
 
 
 def test_unload_with_registered_handler__expect_handler_called(
@@ -217,7 +224,7 @@ def test_unload_with_no_handler__expect_no_error(extension: Extension, bot: Mock
 
 
 def test_get_room_before_load__expect_runtime_error(extension: Extension):
-    with pytest.raises(RuntimeError, match="Extension is not loaded"):
+    with pytest.raises(AssertionError):
         extension.get_room("!room:example.com")
 
 
@@ -241,5 +248,5 @@ def test_get_room_after_unload__expect_runtime_error(
     extension.load(bot)
     extension.unload()
 
-    with pytest.raises(RuntimeError, match="Extension is not loaded"):
+    with pytest.raises(AssertionError):
         extension.get_room("!room:example.com")

{matrix_python-1.4.8a0 → matrix_python-1.4.9a0}/tests/test_registry.py

@@ -5,7 +5,7 @@ from nio import RoomMessageText, RoomMemberEvent, TypingNoticeEvent, ReactionEve
 from matrix.registry import Registry
 from matrix.command import Command
 from matrix.group import Group
-from matrix.errors import AlreadyRegisteredError
+from matrix.errors import AlreadyRegisteredError, CommandNotFoundError, CheckError
 
 
 @pytest.fixture
@@ -334,6 +334,68 @@ def test_register_error_handler_overwrites_previous_handler__expect_latest_handl
     assert registry._error_handlers[ValueError] is second_handler
 
 
+def test_register_command_error_handler_with_exception_type__expect_handler_in_dict(
+    registry: Registry,
+):
+    @registry.error(CommandNotFoundError, context=True)
+    async def on_command_not_found(ctx, error):
+        pass
+
+    assert (
+        registry._command_error_handlers[CommandNotFoundError] is on_command_not_found
+    )
+
+
+def test_register_command_error_handler_with_non_coroutine__expect_type_error(
+    registry: Registry,
+):
+    with pytest.raises(TypeError):
+
+        @registry.error(CommandNotFoundError, context=True)
+        def sync_handler(ctx, error):
+            pass
+
+
+def test_register_multiple_command_error_handlers__expect_all_in_dict(
+    registry: Registry,
+):
+    @registry.error(CommandNotFoundError, context=True)
+    async def on_command_not_found(ctx, error):
+        pass
+
+    @registry.error(CheckError, context=True)
+    async def on_check_error(ctx, error):
+        pass
+
+    assert CommandNotFoundError in registry._command_error_handlers
+    assert CheckError in registry._command_error_handlers
+
+
+def test_register_command_error_handler_overwrites_previous__expect_latest_handler(
+    registry: Registry,
+):
+    @registry.error(CommandNotFoundError, context=True)
+    async def first_handler(ctx, error):
+        pass
+
+    @registry.error(CommandNotFoundError, context=True)
+    async def second_handler(ctx, error):
+        pass
+
+    assert registry._command_error_handlers[CommandNotFoundError] is second_handler
+
+
+def test_register_error_with_context_false__expect_handler_in_error_handlers(
+    registry: Registry,
+):
+    @registry.error(ValueError, context=False)
+    async def on_value_error(error):
+        pass
+
+    assert registry._error_handlers[ValueError] is on_value_error
+    assert ValueError not in registry._command_error_handlers
+
+
 def test_commands_property_with_empty_registry__expect_empty_dict(registry: Registry):
     assert registry.commands == {}