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

matrix_python-1.4.8a0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Sebastián Ramírez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

matrix_python-1.4.8a0/PKG-INFO

@@ -0,0 +1,128 @@
+Metadata-Version: 2.4
+Name: matrix-python
+Version: 1.4.8a0
+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>
+License: The MIT License (MIT)
+        
+        Copyright (c) 2021 Sebastián Ramírez
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in
+        all copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+        THE SOFTWARE.
+Project-URL: Homepage, https://codesociety.xyz
+Project-URL: Source, https://github.com/Code-Society-Lab/matrixpy
+Project-URL: Issues, https://github.com/Code-Society-Lab/matrixpy/issues
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: matrix-nio==0.25.2
+Requires-Dist: logger
+Requires-Dist: PyYAML==6.0.3
+Requires-Dist: markdown==3.10.2
+Requires-Dist: APScheduler==3.11.2
+Requires-Dist: envyaml==1.10.211231
+Provides-Extra: dev
+Requires-Dist: pytest==9.0.3; extra == "dev"
+Requires-Dist: pytest-asyncio==1.3.0; extra == "dev"
+Requires-Dist: black==26.3.1; extra == "dev"
+Requires-Dist: mypy==1.20.0; extra == "dev"
+Requires-Dist: types-PyYAML==6.0.12.20260408; extra == "dev"
+Requires-Dist: types-Markdown==3.10.2.20260408; extra == "dev"
+
+<div align="center">
+  <em>A simple, developer-friendly library to create powerful <a href="https://matrix.org">Matrix</a> bots.</em>
+</div>
+
+<img alt="image" src="https://github.com/user-attachments/assets/d9140a9e-27fa-44e4-a5ca-87ee7bbf868f" />
+
+<hr />
+
+[![Static Badge](https://img.shields.io/badge/%F0%9F%93%9A-Documentation-%235c5c5c)](https://github.com/Code-Society-Lab/matrixpy/wiki)
+[![Join Discord](https://discordapp.com/api/guilds/823178343943897088/widget.png?style=shield)](https://discord.gg/code-society-823178343943897088)
+[![Join Matrix](https://img.shields.io/matrix/codesociety%3Amatrix.org?logo=matrix&label=%20&labelColor=%23202020&color=%23202020)](https://matrix.to/#/%23codesociety:matrix.org )
+[![Tests](https://github.com/Code-Society-Lab/matrixpy/actions/workflows/tests.yml/badge.svg)](https://github.com/Code-Society-Lab/matrixpy/actions/workflows/tests.yml)
+[![CodeQL Advanced](https://github.com/Code-Society-Lab/matrixpy/actions/workflows/codeql.yml/badge.svg)](https://github.com/Code-Society-Lab/matrixpy/actions/workflows/codeql.yml)
+[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/Code-Society-Lab/matrixpy/badge)](https://securityscorecards.dev/viewer/?uri=github.com/Code-Society-Lab/matrixpy)
+
+Matrix.py is a lightweight and intuitive Python library to build bots on
+the [Matrix protocol](https://matrix.org). It provides a clean,
+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
+- Automatic event handler registration
+- Built on [matrix-nio](https://github.com/matrix-nio/matrix-nio)
+
+# Quickstart
+
+**Requirements**
+
+- Python 3.10+
+
+```
+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.
+
+```python
+from matrix import Bot, Context
+
+bot = Bot()
+
+
+@bot.command("ping")
+async def ping(ctx: Context):
+    await ctx.reply("Pong!")
+
+
+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!
+
+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!
+
+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
+
+This project is licensed under the terms
+of [MIT license](https://github.com/Code-Society-Lab/matrixpy/blob/main/LICENSE).

{matrix_python-1.4.6a0 → matrix_python-1.4.8a0}/README.md

@@ -78,4 +78,5 @@ 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)
+This project is licensed under the terms
+of [MIT license](https://github.com/Code-Society-Lab/matrixpy/blob/main/LICENSE).

{matrix_python-1.4.6a0 → matrix_python-1.4.8a0}/matrix/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '1.4.6a0'
-__version_tuple__ = version_tuple = (1, 4, 6, 'a0')
+__version__ = version = '1.4.8a0'
+__version_tuple__ = version_tuple = (1, 4, 8, 'a0')
 
-__commit_id__ = commit_id = 'g9d2b531d5'
+__commit_id__ = commit_id = 'g16bd59854'

{matrix_python-1.4.6a0 → matrix_python-1.4.8a0}/matrix/bot.py

@@ -184,10 +184,6 @@ class Bot(Registry):
             await handler(error)
             return
 
-        if self._fallback_error_handler:
-            await self._fallback_error_handler(error)
-            return
-
         await self._dispatch("on_error", error)
 
     async def on_command(self, _ctx: Context) -> None:
@@ -326,15 +322,19 @@ class Bot(Registry):
 
     async def _process_commands(self, room: Room, event: Event) -> None:
         """Parse and execute commands"""
-        ctx = await self._build_context(room, event)
+        try:
+            ctx = await self._build_context(room, event)
 
-        if ctx.command:
-            for check in self._checks:
-                if not await check(ctx):
-                    raise CheckError(ctx.command, check)
+            if ctx.command:
+                for check in self._checks:
+                    if not await check(ctx):
+                        raise CheckError(ctx.command, check)
 
-            await self._on_command(ctx)
-            await ctx.command(ctx)
+                await self._on_command(ctx)
+                await ctx.command(ctx)
+        except Exception as error:
+            ctx = Context(bot=self, room=room, event=event)
+            await self._on_command_error(ctx, error)
 
     async def _build_context(self, matrix_room: Room, event: Event) -> Context:
         room = self.get_room(matrix_room.room_id)

{matrix_python-1.4.6a0 → matrix_python-1.4.8a0}/matrix/registry.py

@@ -65,7 +65,6 @@ class Registry:
 
         self._event_handlers: Dict[Type[Event], List[Callback]] = defaultdict(list)
         self._hook_handlers: Dict[str, List[Callback]] = defaultdict(list)
-        self._fallback_error_handler: Optional[ErrorCallback] = None
         self._error_handlers: Dict[type[Exception], ErrorCallback] = {}
         self._command_error_handlers: Dict[type[Exception], CommandErrorCallback] = {}
 
@@ -378,14 +377,15 @@ class Registry:
         ```
         """
 
+        if not exception:
+            exception = Exception
+
         def wrapper(func: ErrorCallback) -> ErrorCallback:
             if not inspect.iscoroutinefunction(func):
                 raise TypeError("Error handlers must be coroutines")
 
-            if exception:
-                self._error_handlers[exception] = func
-            else:
-                self._fallback_error_handler = func
+            self._error_handlers[exception] = func
+
             logger.debug(
                 "registered error handler '%s' on %s",
                 func.__name__,

matrix_python-1.4.8a0/matrix_python.egg-info/PKG-INFO

@@ -0,0 +1,128 @@
+Metadata-Version: 2.4
+Name: matrix-python
+Version: 1.4.8a0
+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>
+License: The MIT License (MIT)
+        
+        Copyright (c) 2021 Sebastián Ramírez
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in
+        all copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+        THE SOFTWARE.
+Project-URL: Homepage, https://codesociety.xyz
+Project-URL: Source, https://github.com/Code-Society-Lab/matrixpy
+Project-URL: Issues, https://github.com/Code-Society-Lab/matrixpy/issues
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: matrix-nio==0.25.2
+Requires-Dist: logger
+Requires-Dist: PyYAML==6.0.3
+Requires-Dist: markdown==3.10.2
+Requires-Dist: APScheduler==3.11.2
+Requires-Dist: envyaml==1.10.211231
+Provides-Extra: dev
+Requires-Dist: pytest==9.0.3; extra == "dev"
+Requires-Dist: pytest-asyncio==1.3.0; extra == "dev"
+Requires-Dist: black==26.3.1; extra == "dev"
+Requires-Dist: mypy==1.20.0; extra == "dev"
+Requires-Dist: types-PyYAML==6.0.12.20260408; extra == "dev"
+Requires-Dist: types-Markdown==3.10.2.20260408; extra == "dev"
+
+<div align="center">
+  <em>A simple, developer-friendly library to create powerful <a href="https://matrix.org">Matrix</a> bots.</em>
+</div>
+
+<img alt="image" src="https://github.com/user-attachments/assets/d9140a9e-27fa-44e4-a5ca-87ee7bbf868f" />
+
+<hr />
+
+[![Static Badge](https://img.shields.io/badge/%F0%9F%93%9A-Documentation-%235c5c5c)](https://github.com/Code-Society-Lab/matrixpy/wiki)
+[![Join Discord](https://discordapp.com/api/guilds/823178343943897088/widget.png?style=shield)](https://discord.gg/code-society-823178343943897088)
+[![Join Matrix](https://img.shields.io/matrix/codesociety%3Amatrix.org?logo=matrix&label=%20&labelColor=%23202020&color=%23202020)](https://matrix.to/#/%23codesociety:matrix.org )
+[![Tests](https://github.com/Code-Society-Lab/matrixpy/actions/workflows/tests.yml/badge.svg)](https://github.com/Code-Society-Lab/matrixpy/actions/workflows/tests.yml)
+[![CodeQL Advanced](https://github.com/Code-Society-Lab/matrixpy/actions/workflows/codeql.yml/badge.svg)](https://github.com/Code-Society-Lab/matrixpy/actions/workflows/codeql.yml)
+[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/Code-Society-Lab/matrixpy/badge)](https://securityscorecards.dev/viewer/?uri=github.com/Code-Society-Lab/matrixpy)
+
+Matrix.py is a lightweight and intuitive Python library to build bots on
+the [Matrix protocol](https://matrix.org). It provides a clean,
+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
+- Automatic event handler registration
+- Built on [matrix-nio](https://github.com/matrix-nio/matrix-nio)
+
+# Quickstart
+
+**Requirements**
+
+- Python 3.10+
+
+```
+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.
+
+```python
+from matrix import Bot, Context
+
+bot = Bot()
+
+
+@bot.command("ping")
+async def ping(ctx: Context):
+    await ctx.reply("Pong!")
+
+
+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!
+
+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!
+
+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
+
+This project is licensed under the terms
+of [MIT license](https://github.com/Code-Society-Lab/matrixpy/blob/main/LICENSE).

{matrix_python-1.4.6a0 → matrix_python-1.4.8a0}/matrix_python.egg-info/SOURCES.txt

@@ -33,6 +33,7 @@ matrix/extension.py
 matrix/group.py
 matrix/message.py
 matrix/protocols.py
+matrix/py.typed
 matrix/registry.py
 matrix/room.py
 matrix/scheduler.py

{matrix_python-1.4.6a0 → matrix_python-1.4.8a0}/pyproject.toml

@@ -44,6 +44,9 @@ dev = [
 packages = ["matrix"]
 license-files = []
 
+[tool.setuptools.package-data]
+matrix = ["py.typed"]
+
 [tool.setuptools_scm]
 write_to = "matrix/_version.py"
 

{matrix_python-1.4.6a0 → matrix_python-1.4.8a0}/tests/test_bot.py

@@ -3,9 +3,7 @@ import pytest
 from unittest.mock import AsyncMock, MagicMock, patch
 from nio import MatrixRoom, RoomMessageText
 
-from matrix.bot import Bot
-from matrix.config import Config
-from matrix.extension import Extension
+from matrix.bot import Bot, Config, Extension, Room
 from matrix.errors import (
     CheckError,
     CommandNotFoundError,
@@ -118,7 +116,8 @@ async def test_dispatch_calls_all_handlers(bot):
             "type": "m.room.message",
         }
     )
-    room = MatrixRoom("!roomid:matrix.org", "room_alias")
+    matrix_room = MatrixRoom("!roomid:matrix.org", "room_alias")
+    room = Room(matrix_room, bot.client)
 
     await bot._dispatch_matrix_event(room, event)
     assert "h1" in called
@@ -206,9 +205,7 @@ async def test_on_error_calls_fallback_handler(bot):
         nonlocal called
         called = True
 
-    await bot._fallback_error_handler(Exception("test error"))
-    await bot.on_error(Exception("test error"))
-
+    await bot._on_error(Exception("test error"))
     assert called, "Fallback error handler was not called"
 
 
@@ -245,7 +242,9 @@ async def test_process_commands_executes_command(bot, event):
 
 
 @pytest.mark.asyncio
-async def test_command_not_found_raises(bot):
+async def test_command_not_found_calls_command_error_handler(bot):
+    bot._on_command_error = AsyncMock()
+
     event = RoomMessageText.from_dict(
         {
             "content": {"body": "!nonexistent", "msgtype": "m.text"},
@@ -258,17 +257,14 @@ async def test_command_not_found_raises(bot):
 
     room = MatrixRoom("!roomid", "alias")
 
-    with patch("matrix.context.Context", autospec=True) as MockContext:
-        mock_ctx = MagicMock()
-        mock_ctx.body = "!nonexistent"
-        MockContext.return_value = mock_ctx
+    await bot._process_commands(room, event)
 
-        with pytest.raises(CommandNotFoundError):
-            await bot._process_commands(room, event)
+    bot._on_command_error.assert_awaited_once()
+    assert isinstance(bot._on_command_error.call_args[0][1], CommandNotFoundError)
 
 
 @pytest.mark.asyncio
-async def test_bot_does_not_execute_when_global_check_fails(bot, event):
+async def test_bot_does_not_execute_command_when_global_check_fails(bot):
     called = False
 
     @bot.command()
@@ -280,6 +276,8 @@ async def test_bot_does_not_execute_when_global_check_fails(bot, event):
     async def global_check(ctx):
         return False
 
+    bot._on_command_error = AsyncMock()
+
     event = RoomMessageText.from_dict(
         {
             "content": {"body": "!greet", "msgtype": "m.text"},
@@ -290,18 +288,14 @@ async def test_bot_does_not_execute_when_global_check_fails(bot, event):
         }
     )
 
-    room = MatrixRoom("!roomid", "alias")
+    matrix_room = MatrixRoom("!roomid", "alias")
+    room = Room(matrix_room, bot.client)
 
-    with patch("matrix.context.Context", autospec=True) as MockContext:
-        mock_ctx = MagicMock()
-        mock_ctx.body = "!greet"
-        mock_ctx.command = bot.commands["greet"]
-        MockContext.return_value = mock_ctx
-
-        with pytest.raises(CheckError):
-            await bot._process_commands(room, event)
+    await bot._process_commands(room, event)
 
-    assert not called, "Expected command handler not to be called"
+    assert not called
+    bot._on_command_error.assert_awaited_once()
+    assert isinstance(bot._on_command_error.call_args[0][1], CheckError)
 
 
 @pytest.mark.asyncio

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

@@ -297,16 +297,6 @@ def test_register_error_handler_with_exception_type__expect_handler_in_dict(
     assert registry._error_handlers[ValueError] is on_value_error
 
 
-def test_register_generic_error_handler__expect_fallback_error_handler_set(
-    registry: Registry,
-):
-    @registry.error()
-    async def on_any_error(error):
-        pass
-
-    assert registry._fallback_error_handler is on_any_error
-
-
 def test_register_error_handler_with_non_coroutine__expect_type_error(
     registry: Registry,
 ):