Merge pull request #20 from onyx-and-iris/dependabot/pip/virtualenv-20.36.1

Bump virtualenv from 20.28.1 to 20.36.1

.github/workflows/publish.yml

@@ -38,7 +38,7 @@ jobs:
     runs-on: ubuntu-latest
     environment:
       name: pypi
-      url: https://pypi.org/project/vban-cmd/
+      url: https://pypi.org/project/voicemeeter-api/
     permissions:
       id-token: write
     steps:

.pre-commit-config.yaml

@@ -5,3 +5,9 @@ repos:
       - id: check-yaml
       - id: end-of-file-fixer
       - id: trailing-whitespace
+
+  - repo: https://github.com/python-poetry/poetry
+    rev: '2.3.2'
+    hooks:
+      - id: poetry-check
+      - id: poetry-lock

README.md

@@ -14,9 +14,9 @@ For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)
 
 ## Tested against
 
--   Basic 1.1.1.1
--   Banana 2.1.1.1
--   Potato 3.1.1.1
+-   Basic 1.1.2.2
+-   Banana 2.1.2.2
+-   Potato 3.1.2.2
 
 ## Requirements
 

poetry.lock

@@ -1,4 +1,4 @@
-# This file is automatically @generated by Poetry 2.0.1 and should not be changed by hand.
+# This file is automatically @generated by Poetry 2.2.1 and should not be changed by hand.
 
 [[package]]
 name = "cachetools"
@@ -55,7 +55,7 @@ description = "Backport of PEP 654 (exception groups)"
 optional = false
 python-versions = ">=3.7"
 groups = ["dev"]
-markers = "python_version < \"3.11\""
+markers = "python_version == \"3.10\""
 files = [
     {file = "exceptiongroup-1.2.2-py3-none-any.whl", hash = "sha256:3111b9d131c238bec2f8f516e123e14ba243563fb135d3fe885990585aa7795b"},
     {file = "exceptiongroup-1.2.2.tar.gz", hash = "sha256:47c2edf7c6738fafb49fd34290706d1a1a2f4d1c6df275526b62cbb4aa5393cc"},
@@ -66,21 +66,16 @@ test = ["pytest (>=6)"]
 
 [[package]]
 name = "filelock"
-version = "3.16.1"
+version = "3.20.3"
 description = "A platform independent file lock."
 optional = false
-python-versions = ">=3.8"
+python-versions = ">=3.10"
 groups = ["dev"]
 files = [
-    {file = "filelock-3.16.1-py3-none-any.whl", hash = "sha256:2082e5703d51fbf98ea75855d9d5527e33d8ff23099bec374a134febee6946b0"},
-    {file = "filelock-3.16.1.tar.gz", hash = "sha256:c249fbfcd5db47e5e2d6d62198e565475ee65e4831e2561c8e313fa7eb961435"},
+    {file = "filelock-3.20.3-py3-none-any.whl", hash = "sha256:4b0dda527ee31078689fc205ec4f1c1bf7d56cf88b6dc9426c4f230e46c2dce1"},
+    {file = "filelock-3.20.3.tar.gz", hash = "sha256:18c57ee915c7ec61cff0ecf7f0f869936c7c30191bb0cf406f1341778d0834e1"},
 ]
 
-[package.extras]
-docs = ["furo (>=2024.8.6)", "sphinx (>=8.0.2)", "sphinx-autodoc-typehints (>=2.4.1)"]
-testing = ["covdefaults (>=2.3)", "coverage (>=7.6.1)", "diff-cover (>=9.2)", "pytest (>=8.3.3)", "pytest-asyncio (>=0.24)", "pytest-cov (>=5)", "pytest-mock (>=3.14)", "pytest-timeout (>=2.3.1)", "virtualenv (>=20.26.4)"]
-typing = ["typing-extensions (>=4.12.2)"]
-
 [[package]]
 name = "iniconfig"
 version = "2.0.0"
@@ -243,7 +238,7 @@ description = "A lil' TOML parser"
 optional = false
 python-versions = ">=3.8"
 groups = ["main", "dev"]
-markers = "python_version < \"3.11\""
+markers = "python_version == \"3.10\""
 files = [
     {file = "tomli-2.2.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:678e4fa69e4575eb77d103de3df8a895e1591b48e740211bd1067378c69e8249"},
     {file = "tomli-2.2.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:023aa114dd824ade0100497eb2318602af309e5a55595f76b626d6d9f3b7b0a6"},
@@ -309,37 +304,38 @@ test = ["devpi-process (>=1.0.2)", "pytest (>=8.3.3)", "pytest-mock (>=3.14)"]
 
 [[package]]
 name = "typing-extensions"
-version = "4.12.2"
-description = "Backported and Experimental Type Hints for Python 3.8+"
+version = "4.15.0"
+description = "Backported and Experimental Type Hints for Python 3.9+"
 optional = false
-python-versions = ">=3.8"
+python-versions = ">=3.9"
 groups = ["dev"]
-markers = "python_version < \"3.11\""
+markers = "python_version == \"3.10\""
 files = [
-    {file = "typing_extensions-4.12.2-py3-none-any.whl", hash = "sha256:04e5ca0351e0f3f85c6853954072df659d0d13fac324d0072316b67d7794700d"},
-    {file = "typing_extensions-4.12.2.tar.gz", hash = "sha256:1a7ead55c7e559dd4dee8856e3a88b41225abfe1ce8df57b7c13915fe121ffb8"},
+    {file = "typing_extensions-4.15.0-py3-none-any.whl", hash = "sha256:f0fa19c6845758ab08074a0cfa8b7aecb71c999ca73d62883bc25cc018c4e548"},
+    {file = "typing_extensions-4.15.0.tar.gz", hash = "sha256:0cea48d173cc12fa28ecabc3b837ea3cf6f38c6d1136f85cbaaf598984861466"},
 ]
 
 [[package]]
 name = "virtualenv"
-version = "20.28.1"
+version = "20.36.1"
 description = "Virtual Python Environment builder"
 optional = false
 python-versions = ">=3.8"
 groups = ["dev"]
 files = [
-    {file = "virtualenv-20.28.1-py3-none-any.whl", hash = "sha256:412773c85d4dab0409b83ec36f7a6499e72eaf08c80e81e9576bca61831c71cb"},
-    {file = "virtualenv-20.28.1.tar.gz", hash = "sha256:5d34ab240fdb5d21549b76f9e8ff3af28252f5499fb6d6f031adac4e5a8c5329"},
+    {file = "virtualenv-20.36.1-py3-none-any.whl", hash = "sha256:575a8d6b124ef88f6f51d56d656132389f961062a9177016a50e4f507bbcc19f"},
+    {file = "virtualenv-20.36.1.tar.gz", hash = "sha256:8befb5c81842c641f8ee658481e42641c68b5eab3521d8e092d18320902466ba"},
 ]
 
 [package.dependencies]
 distlib = ">=0.3.7,<1"
-filelock = ">=3.12.2,<4"
+filelock = {version = ">=3.20.1,<4", markers = "python_version >= \"3.10\""}
 platformdirs = ">=3.9.1,<5"
+typing-extensions = {version = ">=4.13.2", markers = "python_version < \"3.11\""}
 
 [package.extras]
 docs = ["furo (>=2023.7.26)", "proselint (>=0.13)", "sphinx (>=7.1.2,!=7.3)", "sphinx-argparse (>=0.4)", "sphinxcontrib-towncrier (>=0.2.1a0)", "towncrier (>=23.6)"]
-test = ["covdefaults (>=2.3)", "coverage (>=7.2.7)", "coverage-enable-subprocess (>=1)", "flaky (>=3.7)", "packaging (>=23.1)", "pytest (>=7.4)", "pytest-env (>=0.8.2)", "pytest-freezer (>=0.4.8)", "pytest-mock (>=3.11.1)", "pytest-randomly (>=3.12)", "pytest-timeout (>=2.1)", "setuptools (>=68)", "time-machine (>=2.10)"]
+test = ["covdefaults (>=2.3)", "coverage (>=7.2.7)", "coverage-enable-subprocess (>=1)", "flaky (>=3.7)", "packaging (>=23.1)", "pytest (>=7.4)", "pytest-env (>=0.8.2)", "pytest-freezer (>=0.4.8) ; platform_python_implementation == \"PyPy\" or platform_python_implementation == \"GraalVM\" or platform_python_implementation == \"CPython\" and sys_platform == \"win32\" and python_version >= \"3.13\"", "pytest-mock (>=3.11.1)", "pytest-randomly (>=3.12)", "pytest-timeout (>=2.1)", "setuptools (>=68)", "time-machine (>=2.10) ; platform_python_implementation == \"CPython\""]
 
 [[package]]
 name = "virtualenv-pyenv"

voicemeeterlib/bus.py

@@ -1,5 +1,5 @@
+import abc
 import time
-from abc import abstractmethod
 from enum import IntEnum
 from math import log
 from typing import Union
@@ -22,7 +22,7 @@ class Bus(IRemote):
     Defines concrete implementation for bus
     """
 
-    @abstractmethod
+    @abc.abstractmethod
     def __str__(self):
         pass
 

voicemeeterlib/cbindings.py

@@ -1,6 +1,5 @@
 import ctypes as ct
 import logging
-from abc import ABCMeta
 from ctypes.wintypes import CHAR, FLOAT, LONG, WCHAR
 
 from .error import CAPIError
@@ -9,11 +8,10 @@ from .inst import libc
 logger = logging.getLogger(__name__)
 
 
-class CBindings(metaclass=ABCMeta):
-    """
-    C bindings defined here.
+class CBindings:
+    """Class responsible for defining C function bindings.
 
-    Maps expected ctype argument and res types for each binding.
+    Wrapper methods are provided for each C function to handle error checking and logging.
     """
 
     logger_cbindings = logger.getChild('CBindings')
@@ -111,7 +109,8 @@ class CBindings(metaclass=ABCMeta):
     bind_get_midi_message.restype = LONG
     bind_get_midi_message.argtypes = [ct.POINTER(CHAR * 1024), LONG]
 
-    def call(self, func, *args, ok=(0,), ok_exp=None):
+    def _call(self, func, *args, ok=(0,), ok_exp=None):
+        """Call a C function and handle errors."""
         try:
             res = func(*args)
             if ok_exp is None:
@@ -123,3 +122,93 @@ class CBindings(metaclass=ABCMeta):
         except CAPIError as e:
             self.logger_cbindings.exception(f'{type(e).__name__}: {e}')
             raise
+
+    def login(self, **kwargs):
+        """Login to Voicemeeter API"""
+        return self._call(self.bind_login, **kwargs)
+
+    def logout(self):
+        """Logout from Voicemeeter API"""
+        return self._call(self.bind_logout)
+
+    def run_voicemeeter(self, value):
+        """Run Voicemeeter with specified type"""
+        return self._call(self.bind_run_voicemeeter, value)
+
+    def get_voicemeeter_type(self, type_ref):
+        """Get Voicemeeter type"""
+        return self._call(self.bind_get_voicemeeter_type, type_ref)
+
+    def get_voicemeeter_version(self, version_ref):
+        """Get Voicemeeter version"""
+        return self._call(self.bind_get_voicemeeter_version, version_ref)
+
+    def is_parameters_dirty(self, **kwargs):
+        """Check if parameters are dirty"""
+        return self._call(self.bind_is_parameters_dirty, **kwargs)
+
+    def macro_button_is_dirty(self, **kwargs):
+        """Check if macro button parameters are dirty"""
+        if hasattr(self, 'bind_macro_button_is_dirty'):
+            return self._call(self.bind_macro_button_is_dirty, **kwargs)
+        raise AttributeError('macro_button_is_dirty not available')
+
+    def get_parameter_float(self, param_name, value_ref):
+        """Get float parameter value"""
+        return self._call(self.bind_get_parameter_float, param_name, value_ref)
+
+    def set_parameter_float(self, param_name, value):
+        """Set float parameter value"""
+        return self._call(self.bind_set_parameter_float, param_name, value)
+
+    def get_parameter_string_w(self, param_name, buffer_ref):
+        """Get string parameter value (Unicode)"""
+        return self._call(self.bind_get_parameter_string_w, param_name, buffer_ref)
+
+    def set_parameter_string_w(self, param_name, value):
+        """Set string parameter value (Unicode)"""
+        return self._call(self.bind_set_parameter_string_w, param_name, value)
+
+    def macro_button_get_status(self, id_, state_ref, mode):
+        """Get macro button status"""
+        if hasattr(self, 'bind_macro_button_get_status'):
+            return self._call(self.bind_macro_button_get_status, id_, state_ref, mode)
+        raise AttributeError('macro_button_get_status not available')
+
+    def macro_button_set_status(self, id_, state, mode):
+        """Set macro button status"""
+        if hasattr(self, 'bind_macro_button_set_status'):
+            return self._call(self.bind_macro_button_set_status, id_, state, mode)
+        raise AttributeError('macro_button_set_status not available')
+
+    def get_level(self, type_, index, value_ref):
+        """Get audio level"""
+        return self._call(self.bind_get_level, type_, index, value_ref)
+
+    def input_get_device_number(self, **kwargs):
+        """Get number of input devices"""
+        return self._call(self.bind_input_get_device_number, **kwargs)
+
+    def output_get_device_number(self, **kwargs):
+        """Get number of output devices"""
+        return self._call(self.bind_output_get_device_number, **kwargs)
+
+    def input_get_device_desc_w(self, index, type_ref, name_ref, hwid_ref):
+        """Get input device description"""
+        return self._call(
+            self.bind_input_get_device_desc_w, index, type_ref, name_ref, hwid_ref
+        )
+
+    def output_get_device_desc_w(self, index, type_ref, name_ref, hwid_ref):
+        """Get output device description"""
+        return self._call(
+            self.bind_output_get_device_desc_w, index, type_ref, name_ref, hwid_ref
+        )
+
+    def get_midi_message(self, buffer_ref, length, **kwargs):
+        """Get MIDI message"""
+        return self._call(self.bind_get_midi_message, buffer_ref, length, **kwargs)
+
+    def set_parameters(self, script):
+        """Set multiple parameters via script"""
+        return self._call(self.bind_set_parameters, script)

voicemeeterlib/device.py

@@ -1,4 +1,4 @@
-from abc import abstractmethod
+import abc
 from typing import Union
 
 from .iremote import IRemote
@@ -7,19 +7,19 @@ from .iremote import IRemote
 class Adapter(IRemote):
     """Adapter to the common interface."""
 
-    @abstractmethod
+    @abc.abstractmethod
     def ins(self):
         pass
 
-    @abstractmethod
+    @abc.abstractmethod
     def outs(self):
         pass
 
-    @abstractmethod
+    @abc.abstractmethod
     def input(self):
         pass
 
-    @abstractmethod
+    @abc.abstractmethod
     def output(self):
         pass
 

voicemeeterlib/factory.py

@@ -1,5 +1,4 @@
 import logging
-from abc import abstractmethod
 from enum import IntEnum
 from functools import cached_property
 from typing import Iterable
@@ -137,11 +136,6 @@ class FactoryBase(Remote):
     def __str__(self) -> str:
         return f'Voicemeeter {self.kind}'
 
-    @property
-    @abstractmethod
-    def steps(self):
-        pass
-
     @cached_property
     def configs(self):
         self._configs = configs(self.kind.name)

voicemeeterlib/iremote.py

@@ -1,11 +1,11 @@
+import abc
 import logging
 import time
-from abc import ABCMeta, abstractmethod
 
 logger = logging.getLogger(__name__)
 
 
-class IRemote(metaclass=ABCMeta):
+class IRemote(abc.ABC):
     """
     Common interface between base class and extended (higher) classes
 
@@ -33,7 +33,7 @@ class IRemote(metaclass=ABCMeta):
             cmd += (f'.{param}',)
         return ''.join(cmd)
 
-    @abstractmethod
+    @abc.abstractmethod
     def identifier(self):
         pass
 

voicemeeterlib/remote.py

@@ -1,8 +1,8 @@
+import abc
 import ctypes as ct
 import logging
 import threading
 import time
-from abc import abstractmethod
 from queue import Queue
 from typing import Iterable, Optional, Union
 
@@ -19,12 +19,13 @@ from .util import deep_merge, grouper, polling, script, timeout
 logger = logging.getLogger(__name__)
 
 
-class Remote(CBindings):
-    """Base class responsible for wrapping the C Remote API"""
+class Remote(abc.ABC):
+    """An abstract base class for Voicemeeter Remote API wrappers. Defines common methods and properties."""
 
     DELAY = 0.001
 
     def __init__(self, **kwargs):
+        self._bindings = CBindings()
         self.strip_mode = 0
         self.cache = {}
         self.midi = Midi()
@@ -52,10 +53,10 @@ class Remote(CBindings):
             self.init_thread()
         return self
 
-    @abstractmethod
-    def __str__(self):
-        """Ensure subclasses override str magic method"""
-        pass
+    @property
+    @abc.abstractmethod
+    def steps(self):
+        """Steps required to build the interface for this Voicemeeter kind"""
 
     def init_thread(self):
         """Starts updates thread."""
@@ -76,7 +77,7 @@ class Remote(CBindings):
     @timeout
     def login(self) -> None:
         """Login to the API, initialize dirty parameters"""
-        self.gui.launched = self.call(self.bind_login, ok=(0, 1)) == 0
+        self.gui.launched = self._bindings.login(ok=(0, 1)) == 0
         if not self.gui.launched:
             self.logger.info(
                 'Voicemeeter engine running but GUI not launched. Launching the GUI now.'
@@ -89,20 +90,20 @@ class Remote(CBindings):
         value = KindId[kind_id.upper()].value
         if BITS == 64 and self.bits == 64:
             value += 3
-        self.call(self.bind_run_voicemeeter, value)
+        self._bindings.run_voicemeeter(value)
 
     @property
     def type(self) -> str:
         """Returns the type of Voicemeeter installation (basic, banana, potato)."""
         type_ = ct.c_long()
-        self.call(self.bind_get_voicemeeter_type, ct.byref(type_))
+        self._bindings.get_voicemeeter_type(ct.byref(type_))
         return KindId(type_.value).name.lower()
 
     @property
     def version(self) -> str:
         """Returns Voicemeeter's version as a string"""
         ver = ct.c_long()
-        self.call(self.bind_get_voicemeeter_version, ct.byref(ver))
+        self._bindings.get_voicemeeter_version(ct.byref(ver))
         return '{}.{}.{}.{}'.format(
             (ver.value & 0xFF000000) >> 24,
             (ver.value & 0x00FF0000) >> 16,
@@ -113,13 +114,13 @@ class Remote(CBindings):
     @property
     def pdirty(self) -> bool:
         """True iff UI parameters have been updated."""
-        return self.call(self.bind_is_parameters_dirty, ok=(0, 1)) == 1
+        return self._bindings.is_parameters_dirty(ok=(0, 1)) == 1
 
     @property
     def mdirty(self) -> bool:
         """True iff MB parameters have been updated."""
         try:
-            return self.call(self.bind_macro_button_is_dirty, ok=(0, 1)) == 1
+            return self._bindings.macro_button_is_dirty(ok=(0, 1)) == 1
         except AttributeError as e:
             self.logger.exception(f'{type(e).__name__}: {e}')
             raise CAPIError('VBVMR_MacroButton_IsDirty', -9) from e
@@ -149,10 +150,10 @@ class Remote(CBindings):
         """Gets a string or float parameter"""
         if is_string:
             buf = ct.create_unicode_buffer(512)
-            self.call(self.bind_get_parameter_string_w, param.encode(), ct.byref(buf))
+            self._bindings.get_parameter_string_w(param.encode(), ct.byref(buf))
         else:
             buf = ct.c_float()
-            self.call(self.bind_get_parameter_float, param.encode(), ct.byref(buf))
+            self._bindings.get_parameter_float(param.encode(), ct.byref(buf))
         return buf.value
 
     def set(self, param: str, val: Union[str, float]) -> None:
@@ -160,12 +161,11 @@ class Remote(CBindings):
         if isinstance(val, str):
             if len(val) >= 512:
                 raise VMError('String is too long')
-            self.call(
-                self.bind_set_parameter_string_w, param.encode(), ct.c_wchar_p(val)
-            )
+            self._bindings.set_parameter_string_w(param.encode(), ct.c_wchar_p(val))
         else:
-            self.call(
-                self.bind_set_parameter_float, param.encode(), ct.c_float(float(val))
+            self._bindings.set_parameter_float(
+                param.encode(),
+                ct.c_float(float(val)),
             )
         self.cache[param] = val
 
@@ -174,8 +174,7 @@ class Remote(CBindings):
         """Gets a macrobutton parameter"""
         c_state = ct.c_float()
         try:
-            self.call(
-                self.bind_macro_button_get_status,
+            self._bindings.macro_button_get_status(
                 ct.c_long(id_),
                 ct.byref(c_state),
                 ct.c_long(mode),
@@ -189,8 +188,7 @@ class Remote(CBindings):
         """Sets a macrobutton parameter. Caches value"""
         c_state = ct.c_float(float(val))
         try:
-            self.call(
-                self.bind_macro_button_set_status,
+            self._bindings.macro_button_set_status(
                 ct.c_long(id_),
                 c_state,
                 ct.c_long(mode),
@@ -204,8 +202,8 @@ class Remote(CBindings):
         """Retrieves number of physical devices connected"""
         if direction not in ('in', 'out'):
             raise VMError('Expected a direction: in or out')
-        func = getattr(self, f'bind_{direction}put_get_device_number')
-        res = self.call(func, ok_exp=lambda r: r >= 0)
+        func = getattr(self._bindings, f'{direction}put_get_device_number')
+        res = func(ok_exp=lambda r: r >= 0)
         return res
 
     def get_device_description(self, index: int, direction: str = None) -> tuple:
@@ -215,9 +213,8 @@ class Remote(CBindings):
         type_ = ct.c_long()
         name = ct.create_unicode_buffer(256)
         hwid = ct.create_unicode_buffer(256)
-        func = getattr(self, f'bind_{direction}put_get_device_desc_w')
-        self.call(
-            func,
+        func = getattr(self._bindings, f'{direction}put_get_device_desc_w')
+        func(
             ct.c_long(index),
             ct.byref(type_),
             ct.byref(name),
@@ -228,9 +225,7 @@ class Remote(CBindings):
     def get_level(self, type_: int, index: int) -> float:
         """Retrieves a single level value"""
         val = ct.c_float()
-        self.call(
-            self.bind_get_level, ct.c_long(type_), ct.c_long(index), ct.byref(val)
-        )
+        self._bindings.get_level(ct.c_long(type_), ct.c_long(index), ct.byref(val))
         return val.value
 
     def _get_levels(self) -> Iterable:
@@ -248,8 +243,7 @@ class Remote(CBindings):
     def get_midi_message(self):
         n = ct.c_long(1024)
         buf = ct.create_string_buffer(1024)
-        res = self.call(
-            self.bind_get_midi_message,
+        res = self._bindings.get_midi_message(
             ct.byref(buf),
             n,
             ok=(-5, -6),  # no data received from midi device
@@ -272,7 +266,7 @@ class Remote(CBindings):
         """Sets many parameters from a script"""
         if len(script) > 48000:
             raise ValueError('Script too large, max size 48kB')
-        self.call(self.bind_set_parameters, script.encode())
+        self._bindings.set_parameters(script.encode())
         time.sleep(self.DELAY * 5)
 
     def apply(self, data: dict):
@@ -339,7 +333,7 @@ class Remote(CBindings):
     def logout(self) -> None:
         """Logout of the API"""
         time.sleep(0.1)
-        self.call(self.bind_logout)
+        self._bindings.logout()
         self.logger.info(f'{type(self).__name__}: Successfully logged out of {self}')
 
     def __exit__(self, exc_type, exc_value, exc_traceback) -> None:

voicemeeterlib/strip.py

@@ -1,5 +1,5 @@
+import abc
 import time
-from abc import abstractmethod
 from math import log
 from typing import Union
 
@@ -15,7 +15,7 @@ class Strip(IRemote):
     Defines concrete implementation for strip
     """
 
-    @abstractmethod
+    @abc.abstractmethod
     def __str__(self):
         pass
 

voicemeeterlib/vban.py

@@ -1,4 +1,4 @@
-from abc import abstractmethod
+import abc
 
 from . import kinds
 from .iremote import IRemote
@@ -11,7 +11,7 @@ class VbanStream(IRemote):
     Defines concrete implementation for vban stream
     """
 
-    @abstractmethod
+    @abc.abstractmethod
     def __str__(self):
         pass