Bump version, fix return types in docstrings

Author: HEnquist

camilladsp/config.py

@@ -108,7 +108,7 @@ def parse_yaml(self, config_string: str) -> Dict:
             config_string (str): A config as raw yaml string.
 
         Returns:
-            Dict | None: Parsed config as a Python dict.
+            Dict: Parsed config as a Python dict.
         """
         config_raw = self.client.query("ReadConfig", arg=config_string)
         config_object = yaml.safe_load(config_raw)
@@ -123,7 +123,7 @@ def parse_json(self, config_string: str) -> Dict:
             config_string (str): A config as raw json string.
 
         Returns:
-            Dict | None: Parsed config as a Python dict.
+            Dict: Parsed config as a Python dict.
         """
         config_raw = self.client.query("ReadConfigJson", arg=config_string)
         config_object = json.loads(config_raw)
@@ -137,7 +137,7 @@ def read_and_parse_file(self, filename: str) -> Dict:
             filename (str): Path to a config file.
 
         Returns:
-            Dict | None: Parsed config as a Python dict.
+            Dict: Parsed config as a Python dict.
         """
         config_raw = self.client.query("ReadConfigFile", arg=filename)
         config = yaml.safe_load(config_raw)
@@ -193,7 +193,7 @@ def validate(self, config_object: Dict) -> Dict:
             config_object (Dict): A configuration as a Python dict.
 
         Returns:
-            Dict | None: Validated config as a Python dict.
+            Dict: Validated config as a Python dict.
         """
         config_string = yaml.dump(config_object)
         validated_string = self.validate_yaml(config_string)

camilladsp/general.py

@@ -120,7 +120,7 @@ def list_playback_devices(self, value: str) -> List[Tuple[str, str]]:
         For some backends, those two names are identical.
 
         Returns:
-            List[Tuple[str, str]: A list containing tuples of two strings,
+            List[Tuple[str, str]]: A list containing tuples of two strings,
                 with system device name and a descriptive name.
         """
         devs = self.client.query("GetAvailablePlaybackDevices", arg=value)
@@ -134,7 +134,7 @@ def list_capture_devices(self, value: str) -> List[Tuple[str, str]]:
         For some backends, those two names are identical.
 
         Returns:
-            List[Tuple[str, str]: A list containing tuples of two strings,
+            List[Tuple[str, str]]: A list containing tuples of two strings,
                 with system device name and a descriptive name.
         """
         devs = self.client.query("GetAvailableCaptureDevices", arg=value)

camilladsp/ratemonitor.py

@@ -31,7 +31,7 @@ def capture(self) -> Optional[int]:
         Returns the nearest common rate, as long as it's within +-4% of the measured value.
 
         Returns:
-            int: The current capture rate.
+            int | None: The current capture rate, or None if not within +-4% of a standard rate.
         """
         rate = self.capture_raw()
         if 0.96 * _STANDARD_RATES[0] < rate < 1.04 * _STANDARD_RATES[-1]:

camilladsp/versions.py

@@ -9,7 +9,7 @@
 
 from .commandgroup import _CommandGroup
 
-VERSION = "4.0.0"
+VERSION = "4.1.0"
 
 
 class Versions(_CommandGroup):
@@ -22,8 +22,8 @@ def camilladsp(self) -> Optional[Tuple[str, str, str]]:
         Read CamillaDSP version.
 
         Returns:
-            Tuple[List[str], List[str]] | None: A tuple containing the CamillaDSP version,
-                as (major, minor, patch).
+            Tuple[str, str, str] | None: A tuple containing the CamillaDSP version,
+                as (major, minor, patch), or None if not connected.
         """
         return self.client.cdsp_version
 
@@ -32,7 +32,7 @@ def library(self) -> Tuple[str, str, str]:
         Read pyCamillaDSP library version.
 
         Returns:
-            Tuple[List[str], List[str]] | None: A tuple containing the pyCamillaDSP version,
+            Tuple[str, str, str]: A tuple containing the pyCamillaDSP version,
                 as (major, minor, patch).
         """
         ver = VERSION.split(".", 2)