patch bump

override str magic method

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "vban-cmd"
-version = "2.4.3"
+version = "2.4.5"
 description = "Python interface for the VBAN RT Packet Service (Sendtext)"
 authors = ["onyx-and-iris <code@onyxandiris.online>"]
 license = "MIT"

tests/banana.svg

@@ -1 +1 @@
-<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="60" height="20" role="img" aria-label="tests: 46"><title>tests: 46</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="60" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="37" height="20" fill="#555"/><rect x="37" width="23" height="20" fill="#4c1"/><rect width="60" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="195" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="270">tests</text><text x="195" y="140" transform="scale(.1)" fill="#fff" textLength="270">tests</text><text aria-hidden="true" x="475" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="130">46</text><text x="475" y="140" transform="scale(.1)" fill="#fff" textLength="130">46</text></g></svg>
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="60" height="20" role="img" aria-label="tests: 48"><title>tests: 48</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="60" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="37" height="20" fill="#555"/><rect x="37" width="23" height="20" fill="#4c1"/><rect width="60" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="195" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="270">tests</text><text x="195" y="140" transform="scale(.1)" fill="#fff" textLength="270">tests</text><text aria-hidden="true" x="475" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="130">48</text><text x="475" y="140" transform="scale(.1)" fill="#fff" textLength="130">48</text></g></svg>

tests/basic.svg

@@ -1 +1 @@
-<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="60" height="20" role="img" aria-label="tests: 48"><title>tests: 48</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="60" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="37" height="20" fill="#555"/><rect x="37" width="23" height="20" fill="#4c1"/><rect width="60" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="195" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="270">tests</text><text x="195" y="140" transform="scale(.1)" fill="#fff" textLength="270">tests</text><text aria-hidden="true" x="475" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="130">48</text><text x="475" y="140" transform="scale(.1)" fill="#fff" textLength="130">48</text></g></svg>
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="60" height="20" role="img" aria-label="tests: 50"><title>tests: 50</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="60" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="37" height="20" fill="#555"/><rect x="37" width="23" height="20" fill="#4c1"/><rect width="60" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="195" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="270">tests</text><text x="195" y="140" transform="scale(.1)" fill="#fff" textLength="270">tests</text><text aria-hidden="true" x="475" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="130">50</text><text x="475" y="140" transform="scale(.1)" fill="#fff" textLength="130">50</text></g></svg>

tests/potato.svg

@@ -1 +1 @@
-<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="60" height="20" role="img" aria-label="tests: 52"><title>tests: 52</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="60" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="37" height="20" fill="#555"/><rect x="37" width="23" height="20" fill="#4c1"/><rect width="60" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="195" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="270">tests</text><text x="195" y="140" transform="scale(.1)" fill="#fff" textLength="270">tests</text><text aria-hidden="true" x="475" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="130">52</text><text x="475" y="140" transform="scale(.1)" fill="#fff" textLength="130">52</text></g></svg>
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="60" height="20" role="img" aria-label="tests: 58"><title>tests: 58</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="60" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="37" height="20" fill="#555"/><rect x="37" width="23" height="20" fill="#4c1"/><rect width="60" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="195" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="270">tests</text><text x="195" y="140" transform="scale(.1)" fill="#fff" textLength="270">tests</text><text aria-hidden="true" x="475" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="130">58</text><text x="475" y="140" transform="scale(.1)" fill="#fff" textLength="130">58</text></g></svg>

tests/test_configs.py

@@ -1,3 +1,5 @@
+import time
+
 import pytest
 
 from tests import data, vban
@@ -11,11 +13,20 @@ class TestSetAndGetBoolHigher:
     @classmethod
     def setup_class(cls):
         vban.apply_config("example")
+        time.sleep(0.1)
 
+    @pytest.mark.skipif(
+        "not config.getoption('--run-slow')",
+        reason="Only run when --run-slow is given",
+    )
     def test_it_tests_config_string(self):
         assert "PhysStrip" in vban.strip[data.phys_in].label
         assert "VirtStrip" in vban.strip[data.virt_in].label
 
+    @pytest.mark.skipif(
+        "not config.getoption('--run-slow')",
+        reason="Only run when --run-slow is given",
+    )
     def test_it_tests_config_bool(self):
         assert vban.strip[0].A1 == True
 

tests/test_errors.py

@@ -0,0 +1,26 @@
+import pytest
+
+import vban_cmd
+from tests import data, vban
+
+
+class TestErrors:
+    __test__ = True
+
+    def test_it_tests_an_unknown_kind(self):
+        with pytest.raises(
+            vban_cmd.error.VBANCMDError,
+            match=f"Unknown Voicemeeter kind 'unknown_kind'",
+        ):
+            vban_cmd.api("unknown_kind")
+
+    def test_it_tests_an_invalid_config(self):
+        EXPECTED_MSG = (
+            f"No config with name 'unknown' is loaded into memory",
+            f"Known configs: {list(vban.configs.keys())}",
+        )
+        with pytest.raises(vban_cmd.error.VBANCMDError) as exc_info:
+            vban.apply_config("unknown")
+
+        e = exc_info.value
+        assert e.message == "\n".join(EXPECTED_MSG)

tests/test_lower.py

@@ -1,5 +1,3 @@
-import time
-
 import pytest
 
 from tests import data, vban
@@ -17,10 +15,6 @@ class TestPublicPacketLower:
         )
 
 
-@pytest.mark.skipif(
-    "not config.getoption('--run-slow')",
-    reason="Only run when --run-slow is given",
-)
 @pytest.mark.parametrize("value", [0, 1])
 class TestSetRT:
     __test__ = True
@@ -35,7 +29,6 @@ class TestSetRT:
         ],
     )
     def test_it_sends_a_text_request(self, kls, index, param, value):
-        vban._set_rt(f"{kls}[{index}]", param, value)
-        time.sleep(0.02)
+        vban._set_rt(f"{kls}[{index}].{param}", value)
         target = getattr(vban, kls)[index]
         assert getattr(target, param) == bool(value)

vban_cmd/bus.py

@@ -26,7 +26,7 @@ class Bus(IRemote):
 
     @property
     def identifier(self) -> str:
-        return f"Bus[{self.index}]"
+        return f"bus[{self.index}]"
 
     @property
     def gain(self) -> float:
@@ -66,7 +66,7 @@ class BusEQ(IRemote):
 
     @property
     def identifier(self) -> str:
-        return f"Bus[{self.index}].eq"
+        return f"bus[{self.index}].eq"
 
 
 class PhysicalBus(Bus):
@@ -116,7 +116,7 @@ class BusLevel(IRemote):
 
     @property
     def identifier(self) -> str:
-        return f"Bus[{self.index}]"
+        return f"bus[{self.index}]"
 
     @property
     def all(self) -> tuple:
@@ -138,7 +138,7 @@ def _make_bus_mode_mixin():
     """Creates a mixin of Bus Modes."""
 
     def identifier(self) -> str:
-        return f"Bus[{self.index}].mode"
+        return f"bus[{self.index}].mode"
 
     def get(self):
         time.sleep(0.01)

vban_cmd/command.py

@@ -30,7 +30,7 @@ class Command(IRemote):
 
     @property
     def identifier(self) -> str:
-        return "Command"
+        return "command"
 
     def set_showvbanchat(self, val: bool):
         self.setter("DialogShow.VBANCHAT", 1 if val else 0)

vban_cmd/error.py

@@ -1,6 +1,13 @@
 class VBANCMDError(Exception):
     """Base VBANCMD Exception class. Raised when general errors occur"""
 
+    def __init__(self, msg):
+        self.message = msg
+        super().__init__(self.message)
+
+    def __str__(self):
+        return f"{type(self).__name__}: {self.message}"
+
 
 class VBANCMDConnectionError(VBANCMDError):
     """Exception raised when connection/timeout errors occur"""

vban_cmd/packet.py

@@ -265,7 +265,7 @@ class VbanRtPacketHeader:
 
 @dataclass
 class RequestHeader:
-    """Represents the header of an REQUEST RT PACKET"""
+    """Represents the header of a REQUEST RT PACKET"""
 
     name: str
     bps_index: int

vban_cmd/strip.py

@@ -20,7 +20,7 @@ class Strip(IRemote):
 
     @property
     def identifier(self) -> str:
-        return f"Strip[{self.index}]"
+        return f"strip[{self.index}]"
 
     @property
     def limit(self) -> int:
@@ -79,7 +79,7 @@ class PhysicalStrip(Strip):
 class StripComp(IRemote):
     @property
     def identifier(self) -> str:
-        return f"Strip[{self.index}].comp"
+        return f"strip[{self.index}].comp"
 
     @property
     def knob(self) -> float:
@@ -157,7 +157,7 @@ class StripComp(IRemote):
 class StripGate(IRemote):
     @property
     def identifier(self) -> str:
-        return f"Strip[{self.index}].gate"
+        return f"strip[{self.index}].gate"
 
     @property
     def knob(self) -> float:
@@ -219,7 +219,7 @@ class StripGate(IRemote):
 class StripDenoiser(IRemote):
     @property
     def identifier(self) -> str:
-        return f"Strip[{self.index}].denoiser"
+        return f"strip[{self.index}].denoiser"
 
     @property
     def knob(self) -> float:
@@ -233,7 +233,7 @@ class StripDenoiser(IRemote):
 class StripEQ(IRemote):
     @property
     def identifier(self) -> str:
-        return f"Strip[{self.index}].eq"
+        return f"strip[{self.index}].eq"
 
     @property
     def on(self):
@@ -312,7 +312,7 @@ class StripLevel(IRemote):
 
     @property
     def identifier(self) -> str:
-        return f"Strip[{self.index}]"
+        return f"strip[{self.index}]"
 
     @property
     def prefader(self) -> tuple:
@@ -345,7 +345,7 @@ class GainLayer(IRemote):
 
     @property
     def identifier(self) -> str:
-        return f"Strip[{self.index}]"
+        return f"strip[{self.index}]"
 
     @property
     def gain(self) -> float:

vban_cmd/util.py

@@ -7,9 +7,8 @@ def cache_bool(func, param):
 
     def wrapper(*args, **kwargs):
         self, *rem = args
-        cmd = f"{self.identifier}.{param}"
-        if cmd in self._remote.cache:
-            return self._remote.cache.pop(cmd) == 1
+        if self._cmd(param) in self._remote.cache:
+            return self._remote.cache.pop(self._cmd(param)) == 1
         if self._remote.sync:
             self._remote.clear_dirty()
         return func(*args, **kwargs)
@@ -22,9 +21,8 @@ def cache_string(func, param):
 
     def wrapper(*args, **kwargs):
         self, *rem = args
-        cmd = f"{self.identifier}.{param}"
-        if cmd in self._remote.cache:
-            return self._remote.cache.pop(cmd)
+        if self._cmd(param) in self._remote.cache:
+            return self._remote.cache.pop(self._cmd(param))
         if self._remote.sync:
             self._remote.clear_dirty()
         return func(*args, **kwargs)

vban_cmd/vban.py

@@ -172,32 +172,24 @@ class VbanMidiOutstream(VbanOutstream):
 def _make_stream_pair(remote, kind):
     num_instream, num_outstream, num_midi, num_text = kind.vban
 
-    def _generate_streams(i, dir):
-        """generator function for creating instream/outstream tuples"""
-        if dir == "in":
-            if i < num_instream:
-                yield VbanAudioInstream
-            elif i < num_instream + num_midi:
-                yield VbanMidiInstream
-            else:
-                yield VbanTextInstream
-        else:
-            if i < num_outstream:
-                yield VbanAudioOutstream
-            else:
-                yield VbanMidiOutstream
+    def _make_cls(i, dir):
+        match dir:
+            case "in":
+                if i < num_instream:
+                    return VbanAudioInstream(remote, i)
+                elif i < num_instream + num_midi:
+                    return VbanMidiInstream(remote, i)
+                else:
+                    return VbanTextInstream(remote, i)
+            case "out":
+                if i < num_outstream:
+                    return VbanAudioOutstream(remote, i)
+                else:
+                    return VbanMidiOutstream(remote, i)
 
     return (
-        tuple(
-            cls(remote, i)
-            for i in range(num_instream + num_midi + num_text)
-            for cls in _generate_streams(i, "in")
-        ),
-        tuple(
-            cls(remote, i)
-            for i in range(num_outstream + num_midi)
-            for cls in _generate_streams(i, "out")
-        ),
+        tuple(_make_cls(i, "in") for i in range(num_instream + num_midi + num_text)),
+        tuple(_make_cls(i, "out") for i in range(num_outstream + num_midi)),
     )
 
 

vban_cmd/vbancmd.py

@@ -50,6 +50,7 @@ class VbanCmd(metaclass=ABCMeta):
         self._pdirty = False
         self._ldirty = False
         self._script = str()
+        self.stop_event = None
 
     @abstractmethod
     def __str__(self):
@@ -109,7 +110,7 @@ class VbanCmd(metaclass=ABCMeta):
         )
 
     def stopped(self):
-        return self.stop_event.is_set()
+        return self.stop_event is None or self.stop_event.is_set()
 
     def _set_rt(self, cmd: str, val: Union[str, float]):
         """Sends a string request command over a network."""