pyrekordbox 0.4.1__py3-none-any.whl → 0.4.3__py3-none-any.whl

pyrekordbox/config.py

@@ -18,7 +18,7 @@ import textwrap
 import time
 import xml.etree.cElementTree as xml
 from pathlib import Path
-from typing import Union
+from typing import Any, Dict, List, Union
 
 import blowfish
 import frida
@@ -67,6 +67,10 @@ def get_appdata_dir() -> Path:
     return app_data
 
 
+def get_cache_file() -> Path:
+    return get_appdata_dir() / "pyrekordbox" / _cache_file_name
+
+
 def get_pioneer_install_dir(path: Union[str, Path] = None) -> Path:  # pragma: no cover
     """Returns the path of the Pioneer program installation directory.
 
@@ -147,7 +151,7 @@ def get_pioneer_app_dir(path: Union[str, Path] = None) -> Path:  # pragma: no co
     return path
 
 
-def _convert_type(s):
+def _convert_type(s: str) -> Union[str, int, float, List[int], List[float]]:
     # Try to parse as int, float, list of int, list of float
     types_ = int, float
     for type_ in types_:
@@ -163,7 +167,7 @@ def _convert_type(s):
     return s
 
 
-def read_rekordbox_settings(rekordbox_app_dir: Union[str, Path]) -> dict:
+def read_rekordbox_settings(rekordbox_app_dir: Union[str, Path]) -> Dict[str, Any]:
     """Finds and parses the 'rekordbox3.settings' file in the Rekordbox 5 or 6 app-dir.
 
     The settings file usually is called 'rekordbox3.settings' and is
@@ -193,12 +197,12 @@ def read_rekordbox_settings(rekordbox_app_dir: Union[str, Path]) -> dict:
             val = _convert_type(element.attrib["val"])
         except KeyError:
             device_setup = element.find("DEVICESETUP")
-            val = {k: _convert_type(v) for k, v in device_setup.attrib.items()}
+            val = {k: _convert_type(v) for k, v in device_setup.attrib.items()}  # type: ignore
         settings[name] = val
     return settings
 
 
-def read_rekordbox6_options(pioneer_app_dir: Union[str, Path]) -> dict:
+def read_rekordbox6_options(pioneer_app_dir: Union[str, Path]) -> Dict[str, Any]:
     """Finds and parses the Rekordbox 6 `options.json` file with additional settings.
 
     The options file contains additional settings used by Rekordbox 6, for example the
@@ -267,7 +271,7 @@ def read_rekordbox6_asar(rb6_install_dir: Union[str, Path]) -> str:
     return data
 
 
-def _extract_version(name, major_version):
+def _extract_version(name: str, major_version: int) -> str:
     name = name.replace(".app", "")  # Needed for MacOS
     ver_str = name.replace("rekordbox", "").strip()
     if not ver_str:
@@ -280,7 +284,7 @@ def _get_rb_config(
     pioneer_app_dir: Path,
     major_version: int,
     application_dirname: str = "",
-) -> dict:
+) -> Dict[str, Any]:
     """Get the program configuration for a given Rekordbox major version.
 
     Parameters
@@ -374,7 +378,9 @@ def _get_rb_config(
     return conf
 
 
-def _get_rb5_config(pioneer_prog_dir: Path, pioneer_app_dir: Path, dirname: str = "") -> dict:
+def _get_rb5_config(
+    pioneer_prog_dir: Path, pioneer_app_dir: Path, dirname: str = ""
+) -> Dict[str, Any]:
     """Get the program configuration for Rekordbox v5.x.x."""
     major_version = 5
     conf = _get_rb_config(pioneer_prog_dir, pioneer_app_dir, major_version, dirname)
@@ -413,16 +419,16 @@ class KeyExtractor:
     """)
     # fmt: on
 
-    def __init__(self, rekordbox_executable):
+    def __init__(self, rekordbox_executable: Union[str, Path]):
         self.executable = str(rekordbox_executable)
         self.key = ""
 
-    def on_message(self, message, data):
+    def on_message(self, message: Dict[str, Any], data: Any) -> None:
         payload = message["payload"]
         if payload.startswith("sqlite3_key"):
             self.key = payload.split(": ")[1]
 
-    def run(self):
+    def run(self) -> str:
         pid = get_rekordbox_pid()
         if pid:
             raise RuntimeError(
@@ -477,7 +483,7 @@ def write_db6_key_cache(key: str) -> None:  # pragma: no cover
     lines.append("dp: " + key)
     text = "\n".join(lines)
 
-    cache_file = get_appdata_dir() / "pyrekordbox" / _cache_file_name
+    cache_file = get_cache_file()
     if not cache_file.parent.exists():
         cache_file.parent.mkdir()
 
@@ -485,16 +491,16 @@ def write_db6_key_cache(key: str) -> None:  # pragma: no cover
         fh.write(text)
     # Set the config key to make sure the key is present after calling method
     if __config__["rekordbox6"]:
-        __config__["rekordbox6"]["dp"] = key
+        __config__["rekordbox6"]["dp"] = key  # type: ignore
     if __config__["rekordbox7"]:
-        __config__["rekordbox7"]["dp"] = key
+        __config__["rekordbox7"]["dp"] = key  # type: ignore
 
 
-def _update_sqlite_key(opts, conf):
+def _update_sqlite_key(opts: Dict[str, Any], conf: Dict[str, Any]) -> None:
     cache_version = 0
     pw, dp = "", ""
 
-    cache_file = get_appdata_dir() / "pyrekordbox" / _cache_file_name
+    cache_file = get_cache_file()
 
     if cache_file.exists():  # pragma: no cover
         logger.debug("Found cache file %s", cache_file)
@@ -533,7 +539,7 @@ def _update_sqlite_key(opts, conf):
         if not dp:
             if pw:
                 cipher = blowfish.Cipher(pw.encode())
-                dp = base64.standard_b64decode(opts["dp"])
+                dp = base64.standard_b64decode(opts["dp"])  # type: ignore
                 dp = b"".join(cipher.decrypt_ecb(dp)).decode()
                 logger.debug("Unlocked dp from pw: %s", dp)
             else:
@@ -574,7 +580,9 @@ def _update_sqlite_key(opts, conf):
         conf["dp"] = dp
 
 
-def _get_rb6_config(pioneer_prog_dir: Path, pioneer_app_dir: Path, dirname: str = "") -> dict:
+def _get_rb6_config(
+    pioneer_prog_dir: Path, pioneer_app_dir: Path, dirname: str = ""
+) -> Dict[str, Any]:
     """Get the program configuration for Rekordbox v6.x.x."""
     major_version = 6
     conf = _get_rb_config(pioneer_prog_dir, pioneer_app_dir, major_version, dirname)
@@ -592,7 +600,9 @@ def _get_rb6_config(pioneer_prog_dir: Path, pioneer_app_dir: Path, dirname: str
     return conf
 
 
-def _get_rb7_config(pioneer_prog_dir: Path, pioneer_app_dir: Path, dirname: str = "") -> dict:
+def _get_rb7_config(
+    pioneer_prog_dir: Path, pioneer_app_dir: Path, dirname: str = ""
+) -> Dict[str, Any]:
     """Get the program configuration for Rekordbox v7.x.x."""
     major_version = 7
     conf = _get_rb_config(pioneer_prog_dir, pioneer_app_dir, major_version, dirname)
@@ -611,7 +621,7 @@ def _get_rb7_config(pioneer_prog_dir: Path, pioneer_app_dir: Path, dirname: str
 
 
 # noinspection PyPackageRequirements,PyUnresolvedReferences
-def _read_config_file(path: str) -> dict:
+def _read_config_file(path: Union[str, Path]) -> Dict[str, Any]:
     path = Path(path)
     if not path.exists():
         raise FileNotFoundError(f"No such file or directory: '{path}'")
@@ -622,20 +632,20 @@ def _read_config_file(path: str) -> dict:
 
         parser = ConfigParser()
         parser.read(path)
-        return parser
+        return {k: v for k, v in parser.items() if v is not None}
     elif ext == ".toml":
         import toml
 
-        return toml.load(path)
+        return dict(toml.load(path))
     elif ext in (".yaml", ".yml"):
         import yaml
 
         with open(path, "r") as stream:
-            return yaml.safe_load(stream)
+            return dict(yaml.safe_load(stream))
     return dict()
 
 
-def read_pyrekordbox_configuration():
+def read_pyrekordbox_configuration() -> Dict[str, Any]:
     """Reads the pyrekordbox configuration.
 
     So far only the `pioneer-install-dir` and `pioneer-app-dir` fileds in the
@@ -673,7 +683,7 @@ def update_config(
     rb5_install_dirname: str = "",
     rb6_install_dirname: str = "",
     rb7_install_dirname: str = "",
-):
+) -> None:
     """Update the pyrekordbox configuration.
 
     This method scans the system for the Rekordbox installation and application data
@@ -754,7 +764,7 @@ def update_config(
         logger.info(e)
 
 
-def get_config(section: str, key: str = None):
+def get_config(section: str, key: str = None) -> Any:
     """Gets a section or value of the pyrekordbox configuration.
 
     Parameters

pyrekordbox/db6/aux_files.py

@@ -5,10 +5,20 @@
 import xml.etree.cElementTree as xml
 from datetime import datetime
 from pathlib import Path
+from typing import Any, Dict, List, Optional, Union
 
 from ..config import get_config
 from ..utils import pretty_xml
 
+Attribs = Dict[str, Any]
+
+
+class XmlElementNotInitializedError(Exception):
+    """Raised when an XML element is not initialized."""
+
+    def __init__(self, name: str) -> None:
+        super().__init__(f"XML element {name} is not initialized!")
+
 
 class MasterPlaylistXml:
     """Rekordbox v6 masterPlaylists6.xml file handler.
@@ -26,7 +36,7 @@ class MasterPlaylistXml:
 
     KEYS = ["Id", "ParentId", "Attributes", "Timestamp", "Lib_Type", "CheckType"]
 
-    def __init__(self, path=None, db_dir=None):
+    def __init__(self, path: Union[str, Path] = None, db_dir: Union[str, Path] = None):
         if path is None:
             if db_dir is None:
                 db_dir = get_config("rekordbox6", "db_dir")
@@ -40,29 +50,33 @@ class MasterPlaylistXml:
         self._changed = False
 
     @property
-    def version(self):
+    def version(self) -> str:
         return self.root.attrib["Version"]
 
     @property
-    def automatic_sync(self):
+    def automatic_sync(self) -> str:
         return self.root.attrib["AutomaticSync"]
 
     @property
-    def rekordbox_version(self):
+    def rekordbox_version(self) -> str:
+        if self.product is None:
+            raise XmlElementNotInitializedError("product")
         return self.product.attrib["Version"]
 
     @property
-    def modified(self):
+    def modified(self) -> bool:
         return self._changed
 
-    def get_playlists(self):
+    def get_playlists(self) -> List[Dict[str, Any]]:
         """Returns a list of the attributes of all playlist elements."""
+        if self.playlists is None:
+            raise XmlElementNotInitializedError("playlists")
         items = list()
         for playlist in self.playlists:
             items.append(playlist.attrib)
         return items
 
-    def get(self, playlist_id):
+    def get(self, playlist_id: Union[str, int]) -> Optional[Attribs]:
         """Returns element attribs with the PlaylistID used in the `master.db` database.
 
         Parameters
@@ -75,11 +89,13 @@ class MasterPlaylistXml:
         -------
         playlist : dict
         """
+        if self.playlists is None:
+            raise XmlElementNotInitializedError("playlists")
         hex_id = f"{int(playlist_id):X}"
         element = self.playlists.find(f'.//NODE[@Id="{hex_id}"]')
         if element is None:
             return None
-        attribs = dict(element.attrib)
+        attribs: Attribs = dict(element.attrib)
         attribs["Attribute"] = int(attribs["Attribute"])
         attribs["Timestamp"] = datetime.fromtimestamp(int(attribs["Timestamp"]) / 1000)
         attribs["Lib_Type"] = int(attribs["Lib_Type"])
@@ -94,7 +110,7 @@ class MasterPlaylistXml:
         updated_at: datetime,
         lib_type: int = 0,
         check_type: int = 0,
-    ):
+    ) -> xml.Element:
         """Adds a new element with the PlaylistID used in the `master.db` database.
 
         Parameters
@@ -119,6 +135,9 @@ class MasterPlaylistXml:
         element : xml.Element
             The newly created element.
         """
+        if self.playlists is None:
+            raise XmlElementNotInitializedError("playlists")
+
         hex_id = f"{int(playlist_id):X}"
         parent_id = f"{int(parent_id):X}" if parent_id != "root" else "0"
         timestamp = int(updated_at.timestamp() * 1000)
@@ -136,7 +155,7 @@ class MasterPlaylistXml:
         self._changed = True
         return element
 
-    def remove(self, playlist_id):
+    def remove(self, playlist_id: Union[str, int]) -> None:
         """Removes the element with the PlaylistID used in the `master.db` database.
 
         Parameters
@@ -145,6 +164,9 @@ class MasterPlaylistXml:
             The playlist ID used in the main `master.db` database. This id is converted
             to hexadecimal format before searching.
         """
+        if self.playlists is None:
+            raise XmlElementNotInitializedError("playlists")
+
         hex_id = f"{int(playlist_id):X}"
         element = self.playlists.find(f'.//NODE[@Id="{hex_id}"]')
         if element is None:
@@ -160,7 +182,7 @@ class MasterPlaylistXml:
         updated_at: datetime = None,
         lib_type: int = None,
         check_type: int = None,
-    ):
+    ) -> None:
         """Updates the element with the PlaylistID used in the `master.db` database.
 
         Parameters
@@ -180,6 +202,9 @@ class MasterPlaylistXml:
         check_type : int, optional
             The check type. It seems to be always 0.
         """
+        if self.playlists is None:
+            raise XmlElementNotInitializedError("playlists")
+
         hex_id = f"{int(playlist_id):X}"
         element = self.playlists.find(f'.//NODE[@Id="{hex_id}"]')
         if element is None:
@@ -200,10 +225,11 @@ class MasterPlaylistXml:
         element.attrib.update(attribs)
         self._changed = True
 
-    def to_string(self, indent=None):
-        return pretty_xml(self.root, indent, encoding="utf-8")
+    def to_string(self, indent: str = None) -> str:
+        text: str = pretty_xml(self.root, indent, encoding="utf-8")
+        return text
 
-    def save(self, path=None, indent=None):
+    def save(self, path: Union[str, Path] = None, indent: str = None) -> None:
         if path is None:
             path = self.path
         path = str(path)