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

pyrekordbox/__init__.py

@@ -2,19 +2,19 @@
 # Author: Dylan Jones
 # Date:   2022-04-10
 
+from .anlz import AnlzFile, get_anlz_paths, read_anlz_files, walk_anlz_paths
+from .config import get_config, show_config, update_config
+from .db6 import Rekordbox6Database
 from .logger import logger
-from .config import show_config, get_config, update_config
-from .rbxml import RekordboxXml, XmlDuplicateError, XmlAttributeKeyError
-from .anlz import get_anlz_paths, walk_anlz_paths, read_anlz_files, AnlzFile
 from .mysettings import (
+    DevSettingFile,
+    DjmMySettingFile,
+    MySetting2File,
+    MySettingFile,
     get_mysetting_paths,
     read_mysetting_file,
-    MySettingFile,
-    MySetting2File,
-    DjmMySettingFile,
-    DevSettingFile,
 )
-from .db6 import Rekordbox6Database, open_rekordbox_database
+from .rbxml import RekordboxXml, XmlAttributeKeyError, XmlDuplicateError
 
 try:
     from ._version import version as __version__

pyrekordbox/__main__.py

@@ -4,11 +4,12 @@
 
 import os
 import re
-import sys
 import shutil
+import sys
 import urllib.request
 from pathlib import Path
-from pyrekordbox.config import write_db6_key_cache, _cache_file
+
+from pyrekordbox.config import _cache_file, write_db6_key_cache
 
 KEY_SOURCES = [
     {

pyrekordbox/_version.py

@@ -1,8 +1,13 @@
-# file generated by setuptools_scm
+# file generated by setuptools-scm
 # don't change, don't track in version control
+
+__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+
 TYPE_CHECKING = False
 if TYPE_CHECKING:
-    from typing import Tuple, Union
+    from typing import Tuple
+    from typing import Union
+
     VERSION_TUPLE = Tuple[Union[int, str], ...]
 else:
     VERSION_TUPLE = object
@@ -12,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.3.2'
-__version_tuple__ = version_tuple = (0, 3, 2)
+__version__ = version = '0.4.1'
+__version_tuple__ = version_tuple = (0, 4, 1)

pyrekordbox/anlz/__init__.py

@@ -5,6 +5,7 @@
 import re
 from pathlib import Path
 from typing import Union
+
 from . import structs
 from .file import AnlzFile
 
@@ -77,7 +78,7 @@ def walk_anlz_dirs(root_dir: Union[str, Path]):
         The path of the root directory.
 
     Yields
-    -------
+    ------
     anlz_dir : str
         The path of a directory containing ANLZ files
     """
@@ -96,7 +97,7 @@ def walk_anlz_paths(root_dir: Union[str, Path]):
         The path of the root directory.
 
     Yields
-    -------
+    ------
     anlz_dir : str
         The path of a directory containing ANLZ files.
     anlz_files : Sequence of str

pyrekordbox/anlz/file.py

@@ -6,10 +6,12 @@ import logging
 from collections import abc
 from pathlib import Path
 from typing import Union
-from .tags import TAGS
-from . import structs
+
 from construct import Int16ub
 
+from . import structs
+from .tags import TAGS
+
 logger = logging.getLogger(__name__)
 
 XOR_MASK = bytearray.fromhex("CB E1 EE FA E5 EE AD EE E9 D2 E9 EB E1 E9 F3 E8 E9 F4 E1")

pyrekordbox/anlz/tags.py

@@ -4,7 +4,9 @@
 
 import logging
 from abc import ABC
+
 import numpy as np
+
 from . import structs
 
 logger = logging.getLogger(__name__)
@@ -160,13 +162,9 @@ class PQTZAnlzTag(AbstractAnlzTag):
         n_bpms = len(bpms)
         n_times = len(times)
         if n_bpms != n_beats:
-            raise ValueError(
-                f"Number of bpms not equal to number of beats: {n_bpms} != {n_beats}"
-            )
+            raise ValueError(f"Number of bpms not equal to number of beats: {n_bpms} != {n_beats}")
         if n_times != n_beats:
-            raise ValueError(
-                f"Number of times not equal to number of beats: {n_bpms} != {n_times}"
-            )
+            raise ValueError(f"Number of times not equal to number of beats: {n_bpms} != {n_times}")
 
         # For now only values of existing beats can be set
         if n_beats != n:
@@ -182,9 +180,7 @@ class PQTZAnlzTag(AbstractAnlzTag):
         n = len(self.content.entries)
         n_new = len(beats)
         if n_new != n:
-            raise ValueError(
-                f"Number of beats not equal to current content length: {n_new} != {n}"
-            )
+            raise ValueError(f"Number of beats not equal to current content length: {n_new} != {n}")
 
         for i, beat in enumerate(beats):
             self.content.entries[i].beat = beat
@@ -193,9 +189,7 @@ class PQTZAnlzTag(AbstractAnlzTag):
         n = len(self.content.entries)
         n_new = len(bpms)
         if n_new != n:
-            raise ValueError(
-                f"Number of bpms not equal to current content length: {n_new} != {n}"
-            )
+            raise ValueError(f"Number of bpms not equal to current content length: {n_new} != {n}")
 
         for i, bpm in enumerate(bpms):
             self.content.entries[i].tempo = int(bpm * 100)
@@ -204,9 +198,7 @@ class PQTZAnlzTag(AbstractAnlzTag):
         n = len(self.content.entries)
         n_new = len(times)
         if n_new != n:
-            raise ValueError(
-                f"Number of times not equal to current content length: {n_new} != {n}"
-            )
+            raise ValueError(f"Number of times not equal to current content length: {n_new} != {n}")
 
         for i, t in enumerate(times):
             self.content.entries[i].time = int(1000 * t)
@@ -439,7 +431,7 @@ class PWV5AnlzTag(AbstractAnlzTag):
     LEN_HEADER = 24
 
     def get(self):
-        """Parse the Waveform Color Detail Tag (PWV5)
+        """Parse the Waveform Color Detail Tag (PWV5).
 
         The format of the entries is:
 

pyrekordbox/config.py

@@ -30,7 +30,7 @@ logger = logging.getLogger(__name__)
 
 # Cache file for pyrekordbox data
 _cache_file_version = 2
-_cache_file = Path(__file__).parent / "rb.cache"
+_cache_file_name = "rb.cache"
 
 # Define empty pyrekordbox configuration
 __config__ = {
@@ -40,6 +40,7 @@ __config__ = {
     },
     "rekordbox5": {},
     "rekordbox6": {},
+    "rekordbox7": {},
 }
 
 
@@ -47,10 +48,30 @@ class InvalidApplicationDirname(Exception):
     pass
 
 
+def get_appdata_dir() -> Path:
+    """Returns the path of the application data directory.
+
+    On Windows, the application data is stored in `/Users/user/AppData/Roaming`.
+    On macOS the application data is stored in `~/Libary/Application Support`.
+    """
+    if sys.platform == "win32":
+        # Windows: located in /Users/user/AppData/Roaming/
+        app_data = Path(os.environ["AppData"])
+    elif sys.platform == "darwin":
+        # MacOS: located in ~/Library/Application Support/
+        app_data = Path("~").expanduser() / "Library" / "Application Support"
+    else:
+        # Linux: not supported
+        logger.warning(f"OS {sys.platform} not supported!")
+        return Path("~").expanduser() / ".local" / "share"
+    return app_data
+
+
 def get_pioneer_install_dir(path: Union[str, Path] = None) -> Path:  # pragma: no cover
     """Returns the path of the Pioneer program installation directory.
 
-    On Windows, the Pioneer program data is stored in `/ProgramFiles/Pioneer`
+    On Windows, the Pioneer program data is stored in `/ProgramFiles/Pioneer`.
+    For rekordbox version 7 this has changed to `/ProgramFiles/rekordbox`.
     On macOS the program data is somewhere in `/Applications/`.
 
     Parameters
@@ -68,7 +89,7 @@ def get_pioneer_install_dir(path: Union[str, Path] = None) -> Path:  # pragma: n
         if sys.platform == "win32":
             # Windows: located in /ProgramFiles/Pioneer
             program_files = os.environ["ProgramFiles"].replace("(x86)", "").strip()
-            path = Path(program_files) / "Pioneer"
+            path = Path(program_files)
         elif sys.platform == "darwin":
             # MacOS: located in /Applications/
             path = Path("/Applications")
@@ -232,12 +253,7 @@ def read_rekordbox6_asar(rb6_install_dir: Union[str, Path]) -> str:
         if not str(rb6_install_dir).endswith(".app"):
             rb6_install_dir = rb6_install_dir / "rekordbox.app"
         location = (
-            rb6_install_dir
-            / "Contents"
-            / "MacOS"
-            / "rekordboxAgent.app"
-            / "Contents"
-            / "Resources"
+            rb6_install_dir / "Contents" / "MacOS" / "rekordboxAgent.app" / "Contents" / "Resources"
         )
         encoding = "cp437"
     else:
@@ -247,7 +263,7 @@ def read_rekordbox6_asar(rb6_install_dir: Union[str, Path]) -> str:
     # Read asar file
     path = (location / "app.asar").absolute()
     with open(path, "rb") as fh:
-        data = fh.read().decode(encoding)
+        data = fh.read().decode(encoding, errors="replace")
     return data
 
 
@@ -284,6 +300,12 @@ def _get_rb_config(
     config : dict
         The program configuration.
     """
+    if sys.platform == "win32":
+        if major_version >= 7:
+            pioneer_install_dir = pioneer_install_dir / "rekordbox"
+        else:
+            pioneer_install_dir = pioneer_install_dir / "Pioneer"
+
     if application_dirname:
         # Applitcation dirname is given, only extract version from it
         # `major_version` is compared to the version string
@@ -328,7 +350,7 @@ def _get_rb_config(
     logger.debug("Found Rekordbox %s install-dir: '%s'", major_version, rb_prog_dir)
 
     # Get Rekordbox application directory path for major release `major_version`
-    name = "rekordbox6" if major_version == 6 else "rekordbox"
+    name = "rekordbox6" if major_version >= 6 else "rekordbox"
     rb_app_dir = pioneer_app_dir / name
     if not rb_app_dir.exists():
         raise FileNotFoundError(f"The directory '{rb_app_dir}' doesn't exist!")
@@ -337,7 +359,7 @@ def _get_rb_config(
     # Get Rekordbox database locations for major release `major_version`
     settings = read_rekordbox_settings(rb_app_dir)
     db_dir = Path(settings["masterDbDirectory"])
-    db_filename = "master.db" if major_version == 6 else "datafile.edb"
+    db_filename = "master.db" if major_version >= 6 else "datafile.edb"
     db_path = db_dir / db_filename
     if not db_path.exists():
         raise FileNotFoundError(f"The Rekordbox database '{db_path}' doesn't exist!")
@@ -352,9 +374,7 @@ 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:
     """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)
@@ -363,7 +383,6 @@ def _get_rb5_config(
 
 def _extract_pw(pioneer_install_dir: Path) -> str:  # pragma: no cover
     """Extract the password for decrypting the Rekordbox 6 database key."""
-
     asar_data = read_rekordbox6_asar(pioneer_install_dir)
     match_result = re.search('pass: ".(.*?)"', asar_data)
     if match_result is None:
@@ -407,8 +426,7 @@ class KeyExtractor:
         pid = get_rekordbox_pid()
         if pid:
             raise RuntimeError(
-                "Rekordbox is running. "
-                "Please close Rekordbox before running the `KeyExtractor`."
+                "Rekordbox is running. Please close Rekordbox before running the `KeyExtractor`."
             )
         # Spawn Rekordbox process and attach to it
         pid = frida.spawn(self.executable)
@@ -427,12 +445,16 @@ class KeyExtractor:
 
 
 def write_db6_key_cache(key: str) -> None:  # pragma: no cover
-    """Writes the decrypted Rekordbox6 database key to the cache file.
+    r"""Writes the decrypted Rekordbox6 database key to the cache file.
 
     This method can also be used to manually cache the database key, provided
     the user has found the key somewhere else. The key can be, for example,
     found in some other projects that hard-coded it.
 
+    The cache file is stored in the application data directory of pyrekordbox:
+    Windows: `C:\Users\<user>\AppData\Roaming\pyrekordbox`
+    macOS: `~/Library/Application Support/pyrekordbox`
+
     Parameters
     ----------
     key : str
@@ -454,32 +476,30 @@ def write_db6_key_cache(key: str) -> None:  # pragma: no cover
     lines.append(f"version: {_cache_file_version}")
     lines.append("dp: " + key)
     text = "\n".join(lines)
-    with open(_cache_file, "w") as fh:
-        fh.write(text)
-    # Set the config key to make sure the key is present after calling method
-    __config__["rekordbox6"]["dp"] = key
 
+    cache_file = get_appdata_dir() / "pyrekordbox" / _cache_file_name
+    if not cache_file.parent.exists():
+        cache_file.parent.mkdir()
 
-def _get_rb6_config(
-    pioneer_prog_dir: Path, pioneer_app_dir: Path, dirname: str = ""
-) -> dict:
-    """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)
+    with open(cache_file, "w") as fh:
+        fh.write(text)
+    # Set the config key to make sure the key is present after calling method
+    if __config__["rekordbox6"]:
+        __config__["rekordbox6"]["dp"] = key
+    if __config__["rekordbox7"]:
+        __config__["rekordbox7"]["dp"] = key
 
-    # Read Rekordbox 6 'options.json' and check db_path
-    opts = read_rekordbox6_options(pioneer_app_dir)
-    db_path = Path(opts["db-path"])
-    db_dir = db_path.parent
-    assert str(conf["db_dir"]) == str(db_dir)
-    assert str(conf["db_path"]) == str(db_path)
 
+def _update_sqlite_key(opts, conf):
     cache_version = 0
     pw, dp = "", ""
-    if _cache_file.exists():  # pragma: no cover
-        logger.debug("Found cache file %s", _cache_file)
+
+    cache_file = get_appdata_dir() / "pyrekordbox" / _cache_file_name
+
+    if cache_file.exists():  # pragma: no cover
+        logger.debug("Found cache file %s", cache_file)
         # Read cache file
-        with open(_cache_file, "r") as fh:
+        with open(cache_file, "r") as fh:
             text = fh.read()
         lines = text.splitlines()
         if lines[0].startswith("version:"):
@@ -520,9 +540,10 @@ def _get_rb6_config(
                 if sys.platform == "win32":
                     executable = conf["install_dir"] / "rekordbox.exe"
                 elif sys.platform == "darwin":
-                    executable = (
-                        conf["install_dir"] / "Contents" / "MacOS" / "rekordbox"
-                    )
+                    install_dir = conf["install_dir"]
+                    if not str(install_dir).endswith(".app"):
+                        install_dir = install_dir / "rekordbox.app"
+                    executable = install_dir / "Contents" / "MacOS" / "rekordbox"
                 else:
                     # Linux: not supported
                     logger.warning(f"OS {sys.platform} not supported!")
@@ -552,6 +573,40 @@ def _get_rb6_config(
     if dp:
         conf["dp"] = dp
 
+
+def _get_rb6_config(pioneer_prog_dir: Path, pioneer_app_dir: Path, dirname: str = "") -> dict:
+    """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)
+
+    # Read Rekordbox 6 'options.json' and check db_path
+    opts = read_rekordbox6_options(pioneer_app_dir)
+    db_path = Path(opts["db-path"])
+    db_dir = db_path.parent
+    assert str(conf["db_dir"]) == str(db_dir)
+    assert str(conf["db_path"]) == str(db_path)
+
+    # Update SQLite key
+    _update_sqlite_key(opts, conf)
+
+    return conf
+
+
+def _get_rb7_config(pioneer_prog_dir: Path, pioneer_app_dir: Path, dirname: str = "") -> dict:
+    """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)
+
+    # Read Rekordbox 6 'options.json' and check db_path
+    opts = read_rekordbox6_options(pioneer_app_dir)
+    db_path = Path(opts["db-path"])
+    db_dir = db_path.parent
+    assert str(conf["db_dir"]) == str(db_dir)
+    assert str(conf["db_path"]) == str(db_path)
+
+    # Update SQLite key
+    _update_sqlite_key(opts, conf)
+
     return conf
 
 
@@ -617,6 +672,7 @@ def update_config(
     pioneer_app_dir: Union[str, Path] = None,
     rb5_install_dirname: str = "",
     rb6_install_dirname: str = "",
+    rb7_install_dirname: str = "",
 ):
     """Update the pyrekordbox configuration.
 
@@ -643,6 +699,9 @@ def update_config(
     rb6_install_dirname : str, optional
         The name of the Rekordbox 6 installation directory. By default, the normal
         directory name is used (Windows: 'rekordbox 6.x.x', macOS: 'rekordbox 6.app').
+    rb7_install_dirname : str, optional
+        The name of the Rekordbox 7 installation directory. By default, the normal
+        directory name is used (Windows: 'rekordbox 7.x.x', macOS: 'rekordbox 7.app').
     """
     # Read config file
     conf = read_pyrekordbox_configuration()
@@ -654,6 +713,8 @@ def update_config(
         rb5_install_dirname = conf["rekordbox5-install-dirname"]
     if not rb6_install_dirname and "rekordbox6-install-dirname" in conf:
         rb6_install_dirname = conf["rekordbox6-install-dirname"]
+    if not rb7_install_dirname and "rekordbox7-install-dirname" in conf:
+        rb7_install_dirname = conf["rekordbox7-install-dirname"]
 
     # Pioneer installation directory
     try:
@@ -673,22 +734,25 @@ def update_config(
 
     # Update Rekordbox 5 config
     try:
-        conf = _get_rb5_config(
-            pioneer_install_dir, pioneer_app_dir, rb5_install_dirname
-        )
+        conf = _get_rb5_config(pioneer_install_dir, pioneer_app_dir, rb5_install_dirname)
         __config__["rekordbox5"].update(conf)
     except FileNotFoundError as e:
         logger.info(e)
 
     # Update Rekordbox 6 config
     try:
-        conf = _get_rb6_config(
-            pioneer_install_dir, pioneer_app_dir, rb6_install_dirname
-        )
+        conf = _get_rb6_config(pioneer_install_dir, pioneer_app_dir, rb6_install_dirname)
         __config__["rekordbox6"].update(conf)
     except FileNotFoundError as e:
         logger.info(e)
 
+    # Update Rekordbox 7 config
+    try:
+        conf = _get_rb7_config(pioneer_install_dir, pioneer_app_dir, rb7_install_dirname)
+        __config__["rekordbox7"].update(conf)
+    except FileNotFoundError as e:
+        logger.info(e)
+
 
 def get_config(section: str, key: str = None):
     """Gets a section or value of the pyrekordbox configuration.
@@ -721,6 +785,7 @@ def pformat_config(indent: str = "   ", hw: int = 14, delim: str = " = ") -> str
     pioneer = get_config("pioneer")
     rb5 = get_config("rekordbox5")
     rb6 = get_config("rekordbox6")
+    rb7 = get_config("rekordbox7")
 
     lines = ["Pioneer:"]
     lines += [f"{indent}{k + delim:<{hw}} {pioneer[k]}" for k in sorted(pioneer.keys())]
@@ -731,6 +796,10 @@ def pformat_config(indent: str = "   ", hw: int = 14, delim: str = " = ") -> str
     if rb6:
         rb6_keys = [k for k in rb6.keys() if k not in ("dp", "p")]
         lines += [f"{indent}{k + delim:<{hw}} {rb6[k]}" for k in sorted(rb6_keys)]
+    lines.append("Rekordbox 7:")
+    if rb7:
+        rb7_keys = [k for k in rb7.keys() if k not in ("dp", "p")]
+        lines += [f"{indent}{k + delim:<{hw}} {rb7[k]}" for k in sorted(rb7_keys)]
     return "\n".join(lines)
 
 

pyrekordbox/db6/__init__.py

@@ -2,6 +2,8 @@
 # Author: Dylan Jones
 # Date:   2022-05-07
 
+from .database import Rekordbox6Database
+from .smartlist import SmartList
 from .tables import (
     AgentRegistry,
     CloudAgentRegistry,
@@ -41,5 +43,3 @@ from .tables import (
     SettingFile,
     UuidIDMap,
 )
-from .smartlist import SmartList
-from .database import Rekordbox6Database, open_rekordbox_database

pyrekordbox/db6/aux_files.py

@@ -2,9 +2,10 @@
 # Author: Dylan Jones
 # Date:   2023-09-10
 
-from pathlib import Path
-from datetime import datetime
 import xml.etree.cElementTree as xml
+from datetime import datetime
+from pathlib import Path
+
 from ..config import get_config
 from ..utils import pretty_xml