base error class added

readme updated

patch bump

README.md

@@ -1,5 +1,6 @@
 [![PyPI version](https://badge.fury.io/py/streamlabsio.svg)](https://badge.fury.io/py/streamlabsio)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/onyx-and-iris/streamlabs-socketio-py/blob/dev/LICENSE)
+[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
 
@@ -70,6 +71,10 @@ The following keyword arguments may be passed:
 -   `token`: str   Streamlabs SocketIO api token.
 -   `raw`: boolean=False    Receive raw data messages as json objects.
 
+The following attribute is available:
+
+-   `raw`: boolean Toggle raw mode at runtime.
+
 ### Attributes
 
 For event data you may inspect the available attributes using `attrs()`.
@@ -83,6 +88,7 @@ def on_twitch_event(event, data):
 
 ### Errors
 
+-   `SteamlabsSIOError`: Base StreamlabsSIO error class
 -   `SteamlabsSIOConnectionError`: Exception raised when connection errors occur
 
 ### Logging

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "streamlabsio"
-version = "1.0.2"
+version = "1.1.1"
 description = "Get real time Twitch/Youtube events through Streamlabs SocketIO API"
 authors = ["onyx-and-iris <code@onyxandiris.online>"]
 license = "MIT"

scripts.py

@@ -1,7 +1,8 @@
 import subprocess
+import sys
 from pathlib import Path
 
 
 def ex_debug():
-    path = Path.cwd() / "examples" / "debug" / "."
-    subprocess.run(["py", str(path)])
+    scriptpath = Path.cwd() / "examples" / "debug" / "."
+    subprocess.run([sys.executable, str(scriptpath)])

streamlabsio/client.py

@@ -33,8 +33,26 @@ class Client:
             raise SteamlabsSIOConnectionError(
                 "no connection could be established to the Streamlabs SIO server"
             ) from e
+        self.log_mode()
         return self
 
+    @property
+    def raw(self):
+        return self._raw
+
+    @raw.setter
+    def raw(self, val):
+        self._raw = val
+        self.log_mode()
+
+    def log_mode(self):
+        info = (f"Running client in {'raw' if self.raw else 'normal'} mode.",)
+        if self.raw:
+            info += ("raw JSON messages will be passed to callbacks",)
+        else:
+            info += ("event data objects will be passed to callbacks",)
+        self.logger.info(" ".join(info))
+
     def _token_from_toml(self) -> str:
         try:
             import tomllib
@@ -56,10 +74,10 @@ class Client:
                 raise FileNotFoundError("config.toml was not found")
             with open(filepath, "rb") as f:
                 conn = tomllib.load(f)
-                assert "token" in conn.get(
-                    "streamlabs"
-                ), "token not found in config.toml"
-            return conn["streamlabs"].get("token")
+                assert (
+                    "streamlabs" in conn and "token" in conn["streamlabs"]
+                ), "expected [streamlabs][token] in config.toml"
+            return conn["streamlabs"]["token"]
         except (FileNotFoundError, tomllib.TOMLDecodeError) as e:
             self.logger.error(f"{type(e).__name__}: {e}")
             raise
@@ -71,13 +89,11 @@ class Client:
         if "for" in data and data["type"] in set(
             self.streamlabs + self.twitch + self.youtube
         ):
-            message = data["message"][0] if isinstance(data["message"][0], dict) else {}
+            message = data["message"][0]
             self.obs.trigger(
                 data["for"],
                 data["type"],
-                message
-                if self._raw
-                else as_dataclass(data["type"], message),
+                message if self.raw else as_dataclass(data["type"], message),
             )
             self.logger.debug(data)
 

streamlabsio/error.py

@@ -1,2 +1,6 @@
-class SteamlabsSIOConnectionError(Exception):
+class SteamlabsSIOError(Exception):
+    """Base StreamlabsSIO error class"""
+
+
+class SteamlabsSIOConnectionError(SteamlabsSIOError):
     """Exception raised when connection errors occur"""