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

{matrix_python-1.4.5a0 → matrix_python-1.4.6a0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: matrix-python
-Version: 1.4.5a0
+Version: 1.4.6a0
 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>
@@ -689,6 +689,7 @@ 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"

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

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

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

@@ -245,8 +245,7 @@ class Bot(Registry):
         :func:`asyncio.run`, and ensures the client is closed gracefully
         on interruption.
         """
-        if config is not None:
-            self._load_config(config)
+        self._load_config(config)
 
         try:
             asyncio.run(self.run())
@@ -264,7 +263,7 @@ class Bot(Registry):
         calls the :meth:`on_ready` hook, and starts the long-running
         sync loop for receiving events.
         """
-        self.client.user = self.config.user_id
+        self.client.user = self.config.username
 
         self.start_at = time.time()
         self.log.info("starting – timestamp=%s", self.start_at)

matrix_python-1.4.6a0/matrix/config.py

@@ -0,0 +1,125 @@
+from typing import Any
+
+from envyaml import EnvYAML
+
+from .errors import ConfigError
+
+
+class Config:
+    """Configuration handler for Matrix client settings.
+
+    Manages all settings required to connect and authenticate with a Matrix
+    homeserver. Configuration can be loaded from a YAML file or provided
+    directly via constructor parameters. At least one authentication method
+    must be provided.
+
+    # Example
+
+    ```python
+    # Load from file
+    config = Config(config_path="path/to/config..yaml")
+
+    # Manual configuration
+    config = Config(username="@bot:matrix.org", password="secret")
+    ```
+    """
+
+    def __init__(
+        self,
+        config_path: str | None = None,
+        *,
+        homeserver: str | None = None,
+        username: str | None = None,
+        password: str | None = None,
+        token: str | None = None,
+        prefix: str | None = None,
+    ) -> None:
+        """Initialize the bot configuration.
+
+        Loads configuration from a YAML file if provided, otherwise uses
+        the provided parameters directly. At least one of password or token
+        must be supplied.
+
+        # Example
+
+        ```python
+        config = Config(
+            username="@bot:matrix.org",
+            password="secret",
+            prefix="!",
+        )
+        ```
+        """
+        self._data: dict[str, Any] = {}
+
+        self.homeserver: str = homeserver or "https://matrix.org"
+        self.username: str | None = username
+        self.password: str | None = password
+        self.token: str | None = token
+        self.prefix: str = prefix or "!"
+
+        if config_path:
+            self.load_from_file(config_path)
+        else:
+            if not self.password and not self.token:
+                raise ConfigError("username and password or token")
+
+            self._data = {
+                "HOMESERVER": self.homeserver,
+                "USERNAME": self.username,
+                "PASSWORD": self.password,
+                "TOKEN": self.token,
+                "PREFIX": self.prefix,
+            }
+
+    def load_from_file(self, config_path: str) -> None:
+        """Load Matrix client settings from a YAML config file.
+
+        Supports environment variable substitution via EnvYAML. Values in
+        the YAML file can reference environment variables using ${VAR} syntax.
+
+        # Example
+
+        ```python
+        config = Config()
+        config.load_from_file("path/to/config.yaml")
+        ```
+        """
+        self._data = dict(EnvYAML(config_path))
+
+        password = self._data.get("PASSWORD", None)
+        token = self._data.get("TOKEN", None)
+
+        if not password and not token:
+            raise ConfigError("USERNAME and PASSWORD or TOKEN")
+
+        self.homeserver = self._data.get("HOMESERVER", "https://matrix.org")
+        self.username = self._data.get("USERNAME")
+        self.password = password
+        self.token = token
+        self.prefix = self._data.get("PREFIX", "!")
+
+    def get(self, key: str, *, section: str | None = None, default: Any = None) -> Any:
+        """Access a config value by key, optionally scoped to a section.
+
+        # Example
+
+        ```python
+        config.get(key="main_channel", section="bot")
+        config.get(key="log_level", default="INFO")
+        ```
+        """
+        if section in self._data:
+            return self._data.get(section, {}).get(key, default)
+        return self._data.get(key, default)
+
+    def __getitem__(self, key: str) -> Any:
+        """Access a config value by key, raising KeyError if not found.
+
+        # Example
+
+        ```python
+        config["bot"]["main_channel"]
+        ```
+        """
+        return self._data[key]

{matrix_python-1.4.5a0 → matrix_python-1.4.6a0}/matrix_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: matrix-python
-Version: 1.4.5a0
+Version: 1.4.6a0
 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>
@@ -689,6 +689,7 @@ 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"

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

@@ -45,8 +45,6 @@ matrix_python.egg-info/SOURCES.txt
 matrix_python.egg-info/dependency_links.txt
 matrix_python.egg-info/requires.txt
 matrix_python.egg-info/top_level.txt
-tests/config_fixture.yaml
-tests/config_fixture_token.yaml
 tests/test_bot.py
 tests/test_command.py
 tests/test_config.py

{matrix_python-1.4.5a0 → matrix_python-1.4.6a0}/matrix_python.egg-info/requires.txt

@@ -3,6 +3,7 @@ logger
 PyYAML==6.0.3
 markdown==3.10.2
 APScheduler==3.11.2
+envyaml==1.10.211231
 
 [dev]
 pytest==9.0.3

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

@@ -22,6 +22,7 @@ dependencies = [
     "PyYAML==6.0.3",
     "markdown==3.10.2",
     "APScheduler==3.11.2",
+    "envyaml==1.10.211231",
 ]
 
 [project.optional-dependencies]

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

@@ -16,7 +16,30 @@ from matrix.errors import (
 @pytest.fixture
 def bot():
     b = Bot()
-    b._load_config("tests/config_fixture.yaml")
+    b._load_config(
+        Config(
+            username="grace",
+            password="grace1234",
+        )
+    )
+
+    b._client = MagicMock()
+    b._client.room_send = AsyncMock()
+    b.log = MagicMock()
+    b.log.getChild.return_value = MagicMock()
+
+    return b
+
+
+@pytest.fixture
+def bot_with_token():
+    b = Bot()
+    b._load_config(
+        Config(
+            username="grace",
+            token="abc123",
+        )
+    )
 
     b._client = MagicMock()
     b._client.room_send = AsyncMock()
@@ -50,7 +73,7 @@ def test_bot_init_with_config():
     bot = Bot()
     bot._load_config(Config(username="grace", password="grace1234"))
 
-    assert bot.config.user_id == "grace"
+    assert bot.config.username == "grace"
     assert bot.config.password == "grace1234"
     assert bot.config.homeserver == "https://matrix.org"
 
@@ -411,17 +434,14 @@ async def start_and_stop(coro):
 
 
 @pytest.mark.asyncio
-async def test_run_uses_token():
-    bot = Bot()
-    bot._load_config("tests/config_fixture_token.yaml")
-
-    bot._client.sync_forever = AsyncMock()
-    bot._on_ready = AsyncMock()
+async def test_run_uses_token(bot_with_token):
+    bot_with_token._client.sync_forever = AsyncMock()
+    bot_with_token._on_ready = AsyncMock()
 
     # unblock readiness
-    bot._synced.set()
+    bot_with_token._synced.set()
 
-    task = asyncio.create_task(bot.run())
+    task = asyncio.create_task(bot_with_token.run())
 
     await asyncio.sleep(0)
     await asyncio.sleep(0)
@@ -429,14 +449,22 @@ async def test_run_uses_token():
     task.cancel()
     await asyncio.gather(task, return_exceptions=True)
 
-    assert bot._client.access_token == "abc123"
-    bot._on_ready.assert_awaited_once()
-    bot._client.sync_forever.assert_awaited_once()
+    assert bot_with_token._client.access_token == "abc123"
+    bot_with_token._on_ready.assert_awaited_once()
+    bot_with_token._client.sync_forever.assert_awaited_once()
 
 
 @pytest.mark.asyncio
 async def test_run_with_username_and_password(bot):
-    bot._client.login = AsyncMock(return_value="login_resp")
+    assert bot.config.token is None
+
+    login_called = asyncio.Event()
+
+    async def mock_login(password):
+        login_called.set()
+        return "login_resp"
+
+    bot._client.login = AsyncMock(side_effect=mock_login)
     bot._client.sync_forever = AsyncMock()
     bot._on_ready = AsyncMock()
 
@@ -444,15 +472,13 @@ async def test_run_with_username_and_password(bot):
 
     task = asyncio.create_task(bot.run())
 
-    await asyncio.sleep(0)
-    await asyncio.sleep(0)
+    await asyncio.wait_for(login_called.wait(), timeout=1.0)
 
     task.cancel()
     await asyncio.gather(task, return_exceptions=True)
 
     bot._client.login.assert_awaited_once_with("grace1234")
     bot._on_ready.assert_awaited_once()
-    bot._client.sync_forever.assert_awaited_once()
 
 
 def test_start_handles_keyboard_interrupt(caplog):
@@ -463,7 +489,12 @@ def test_start_handles_keyboard_interrupt(caplog):
 
     with patch.object(bot, "_load_config"):
         with caplog.at_level("INFO"):
-            bot.start(config="tests/config_fixture.yaml")
+            bot.start(
+                config=Config(
+                    username="grace",
+                    password="grace1234",
+                )
+            )
 
     assert "bot interrupted by user" in caplog.text
     bot._client.close.assert_awaited_once()

matrix_python-1.4.6a0/tests/test_config.py

@@ -0,0 +1,139 @@
+import os
+from unittest.mock import patch
+
+import pytest
+import yaml
+
+from matrix.config import Config
+from matrix.errors import ConfigError
+
+
+@pytest.fixture
+def config_default():
+    return Config(username="grace", password="secret")
+
+
+@pytest.fixture
+def config_file(tmp_path):
+    config = tmp_path / "test.yaml"
+    config.write_text(
+        "USERNAME: '@bot:matrix.org'\n"
+        "PASSWORD: 'secret'\n"
+        "PREFIX: '!'\n"
+        "LOG_LEVEL: 'INFO'\n"
+        "bot:\n"
+        "  main_channel: '!abc123:matrix.org'\n"
+    )
+    return config
+
+
+@pytest.fixture
+def config(config_file):
+    return Config(config_path=str(config_file))
+
+
+def test_get__returns_top_level_value(config: Config) -> None:
+    assert config.get(key="LOG_LEVEL") == "INFO"
+
+
+def test_get__returns_none_when_key_missing_and_no_default(config: Config) -> None:
+    assert config.get(key="MISSING") is None
+
+
+def test_get__returns_default_when_key_missing(config: Config) -> None:
+    assert config.get(key="MISSING", default="fallback") == "fallback"
+
+
+def test_get__returns_section_value(config: Config) -> None:
+    assert config.get(key="main_channel", section="bot") == "!abc123:matrix.org"
+
+
+def test_get__returns_default_when_section_missing(config: Config) -> None:
+    assert (
+        config.get(key="main_channel", section="MISSING", default="fallback")
+        == "fallback"
+    )
+
+
+def test_get__returns_default_when_section_key_missing(config: Config) -> None:
+    assert config.get(key="MISSING", section="bot", default="fallback") == "fallback"
+
+
+def test_getitem__returns_value(config: Config) -> None:
+    assert config["LOG_LEVEL"] == "INFO"
+
+
+def test_getitem__raises_key_error_when_missing(config: Config) -> None:
+    with pytest.raises(KeyError):
+        _ = config["MISSING"]
+
+
+@pytest.mark.parametrize(
+    "attr,expected",
+    [
+        ("homeserver", "https://matrix.org"),
+        ("username", "grace"),
+        ("password", "secret"),
+        ("token", None),
+        ("prefix", "!"),
+    ],
+)
+def test_config_defaults_success(config_default, attr, expected):
+    assert getattr(config_default, attr) == expected
+
+
+def test_loading_valid_yaml(tmp_path):
+    yaml_text = """
+    HOMESERVER: https://matrix.org
+    USERNAME:   "@grace:matrix.org"
+    PASSWORD:    grace1234
+    PREFIX:     "/"
+    """
+    config_file = tmp_path / "good.yaml"
+    config_file.write_text(yaml_text)
+
+    cfg = Config(str(config_file))
+
+    assert cfg.username == "@grace:matrix.org"
+    assert cfg.password == "grace1234"
+    assert cfg.prefix == "/"
+
+
+def test_file_not_found(tmp_path):
+    with pytest.raises(FileNotFoundError):
+        Config(str(tmp_path / "nope.yaml"))
+
+
+def test_bad_yaml_syntax(tmp_path):
+    bad = tmp_path / "bad.yaml"
+    bad.write_text("not: valid: : yaml")
+    with pytest.raises(yaml.YAMLError):
+        Config(str(bad))
+
+
+def test_missing_credentials_raises_ConfigError_kwargs():
+    with pytest.raises(ConfigError) as exc:
+        Config(username="only_user")
+    # the assert make sure that the error is raised from
+    # the constructor and not load_from_file method
+    assert "username and password or token" in str(exc.value)
+
+
+def test_missing_credentials_raises_ConfigError_yaml(tmp_path):
+    yaml_text = "HOMESERVER: https://matrix.org\n" "PASSWORD: \n" "TOKEN: \n"
+    file = tmp_path / "err.yaml"
+    file.write_text(yaml_text)
+
+    with patch.dict(os.environ, {}, clear=True):
+        with pytest.raises(ConfigError) as exc:
+            Config(config_path=str(file))
+        assert "USERNAME and PASSWORD or TOKEN" in str(exc.value)
+
+
+def test_token_only():
+    token = "my_very_secure_token"
+    cfg = Config(token=token)
+
+    assert cfg.token == token
+    assert cfg.password is None
+    assert cfg.homeserver == "https://matrix.org"

matrix_python-1.4.5a0/matrix/config.py

@@ -1,61 +0,0 @@
-import yaml
-from .errors import ConfigError
-from typing import Optional
-
-
-class Config:
-    """
-    Configuration handler for Matrix client settings. Including the following:
-
-        homeserver: Defaults to 'https://matrix.org'
-        user_id: The Matrix user ID (username).
-        password: (Optional) One of the password or token must be provided.
-        token: (Optional) One of the password or token must be provided.
-        prefix: Defaults to '!' if not specified in the config file.
-
-    :param config_path: Path to the YAML configuration file.
-    :param homeserver: The Matrix homeserver URL.
-    :param username: The Matrix user ID (username).
-    :param password: The password for the Matrix user.
-    :param token: The access token for the Matrix user.
-    :param prefix: The command prefix.
-
-    :raises FileNotFoundError: If the configuration file does not exist.
-    :raises yaml.YAMLError: If the configuration file cannot be parsed.
-    :raises ConfigError: If neither password or token has been provided.
-    """
-
-    def __init__(
-        self,
-        config_path: Optional[str] = None,
-        *,
-        homeserver: Optional[str] = None,
-        username: Optional[str] = None,
-        password: Optional[str] = None,
-        token: Optional[str] = None,
-        prefix: Optional[str] = None,
-    ) -> None:
-        self.homeserver: str = homeserver or "https://matrix.org"
-        self.user_id: Optional[str] = username
-        self.password: Optional[str] = password
-        self.token: Optional[str] = token
-        self.prefix: str = prefix or "!"
-
-        if config_path:
-            self.load_from_file(config_path)
-        elif not (self.password or self.token):
-            raise ConfigError("username and password or token")
-
-    def load_from_file(self, config_path: str) -> None:
-        """Load Matrix client settings via YAML config file."""
-        with open(config_path, "r") as f:
-            config = yaml.safe_load(f)
-
-            if not (config.get("PASSWORD") or config.get("TOKEN")):
-                raise ConfigError("USERNAME and PASSWORD or TOKEN")
-
-            self.homeserver = config.get("HOMESERVER", "https://matrix.org")
-            self.user_id = config.get("USERNAME")
-            self.password = config.get("PASSWORD", None)
-            self.token = config.get("TOKEN", None)
-            self.prefix = config.get("PREFIX", "!")

matrix_python-1.4.5a0/tests/config_fixture.yaml

@@ -1,4 +0,0 @@
-HOMESERVER: "matrix.fixture.org"
-USERNAME: "grace"
-PASSWORD: "grace1234"
-PREFIX: "!"

matrix_python-1.4.5a0/tests/config_fixture_token.yaml

@@ -1 +0,0 @@
-TOKEN: "abc123"

matrix_python-1.4.5a0/tests/test_config.py

@@ -1,81 +0,0 @@
-import pytest
-import yaml
-
-from matrix.errors import ConfigError
-from matrix.config import Config
-
-
-@pytest.fixture
-def config_default():
-    return Config(username="grace", password="secret")
-
-
-@pytest.mark.parametrize(
-    "attr,expected",
-    [
-        ("homeserver", "https://matrix.org"),
-        ("user_id", "grace"),
-        ("password", "secret"),
-        ("token", None),
-        ("prefix", "!"),
-    ],
-)
-def test_config_defaults_success(config_default, attr, expected):
-    assert getattr(config_default, attr) == expected
-
-
-def test_loading_valid_yaml(tmp_path):
-    yaml_text = """
-    HOMESERVER: https://matrix.org
-    USERNAME:   "@grace:matrix.org"
-    PASSWORD:    grace1234
-    PREFIX:     "/"
-    """
-    config_file = tmp_path / "good.yaml"
-    config_file.write_text(yaml_text)
-
-    cfg = Config(str(config_file))
-
-    assert cfg.user_id == "@grace:matrix.org"
-    assert cfg.password == "grace1234"
-    assert cfg.prefix == "/"
-
-
-def test_file_not_found(tmp_path):
-    with pytest.raises(FileNotFoundError):
-        Config(str(tmp_path / "nope.yaml"))
-
-
-def test_bad_yaml_syntax(tmp_path):
-    bad = tmp_path / "bad.yaml"
-    bad.write_text("not: valid: : yaml")
-    with pytest.raises(yaml.YAMLError):
-        Config(str(bad))
-
-
-def test_missing_credentials_raises_ConfigError_kwargs():
-    with pytest.raises(ConfigError) as exc:
-        Config(username="only_user")
-    # the assert make sure that the error is raised from
-    # the constructor and not load_from_file method
-    assert "username and password or token" in str(exc.value)
-
-
-def test_missing_credentials_raises_ConfigError_yaml(tmp_path):
-    yaml_text = "HOMESERVER: https://matrix.org"
-    file = tmp_path / "err.yaml"
-    file.write_text(yaml_text)
-    with pytest.raises(ConfigError) as exc:
-        Config(str(file))
-    # the assert make sure that the error is raised from
-    # the load_from_file method and not the constructor
-    assert "USERNAME and PASSWORD or TOKEN" in str(exc.value)
-
-
-def test_token_only():
-    token = "my_very_secure_token"
-    cfg = Config(token=token)
-
-    assert cfg.token == token
-    assert cfg.password is None
-    assert cfg.homeserver == "https://matrix.org"