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

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/config.py

@@ -1,61 +1,125 @@
-import yaml
+from typing import Any
+
+from envyaml import EnvYAML
+
 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.
+    """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: Optional[str] = None,
+        config_path: str | None = None,
         *,
-        homeserver: Optional[str] = None,
-        username: Optional[str] = None,
-        password: Optional[str] = None,
-        token: Optional[str] = None,
-        prefix: Optional[str] = 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.user_id: Optional[str] = username
-        self.password: Optional[str] = password
-        self.token: Optional[str] = token
+        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)
-        elif not (self.password or self.token):
-            raise ConfigError("username and password or token")
+        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 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", "!")
+        """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.4a0.dist-info → matrix_python-1.4.6a0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: matrix-python
-Version: 1.4.4a0
+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>
@@ -684,18 +684,19 @@ 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
+Requires-Dist: matrix-nio==0.25.2
 Requires-Dist: logger
-Requires-Dist: PyYAML
-Requires-Dist: markdown
-Requires-Dist: APScheduler
+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; extra == "dev"
-Requires-Dist: pytest-asyncio; extra == "dev"
-Requires-Dist: black; extra == "dev"
-Requires-Dist: mypy; extra == "dev"
-Requires-Dist: types-PyYAML; extra == "dev"
-Requires-Dist: types-Markdown; 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>

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

@@ -1,9 +1,9 @@
 matrix/__init__.py,sha256=g8yEFjELnnwlvOKns-Ug6LgOezkjAFZ-Opt7esbBHKg,728
-matrix/_version.py,sha256=tcfrwnvkUDHHz8JoKK522ystGqqHOEnmR8F4E8SoWsI,528
-matrix/bot.py,sha256=4gwL2vawLFEREwZD4cEydv6XSXm_SP6pztLD8uwB86M,11944
+matrix/_version.py,sha256=rxov6PXTQVt5rKd2h-A8n5ETLEXZ52KLdqbL608ZU2s,528
+matrix/bot.py,sha256=NpCZQMHr6rD4DDYDywQErE4fCMW1KZrU0lOF2ZIzuAc,11910
 matrix/checks.py,sha256=F_7432_OcFO-im4fRAj62MUsyv1mXywT4OsGC_7xbBQ,486
 matrix/command.py,sha256=GrP3WsT07sKehGX7PHfnT7gRX22d99877VPd0X2ViEw,10514
-matrix/config.py,sha256=wPLfcHGpSapkBqbZIuI7zBdxh52OHTD8cQS0WqQkMeU,2388
+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
@@ -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.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,,
+matrix_python-1.4.6a0.dist-info/METADATA,sha256=_LnIZv4FZ76G_ncBzjfbwhb0B2ahf4vkMWrvXR1Jf4c,44672
+matrix_python-1.4.6a0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+matrix_python-1.4.6a0.dist-info/top_level.txt,sha256=BvHVM9c7-5SLzg-1OCRpHKgqAubWhRN1e38e6coHs-g,7
+matrix_python-1.4.6a0.dist-info/RECORD,,