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

pyrekordbox/db6/registry.py

@@ -4,9 +4,19 @@
 
 import logging
 from contextlib import contextmanager
+from datetime import datetime
+from typing import TYPE_CHECKING, Any, Iterator, List, Tuple, Type
 
 from sqlalchemy.orm.exc import ObjectDeletedError
 
+if TYPE_CHECKING:
+    from .database import Rekordbox6Database
+    from .tables import AgentRegistry
+
+
+Instances = Any
+RegistryUpdateItem = Tuple[Instances, str, str, Any]
+
 logger = logging.getLogger(__name__)
 
 
@@ -27,15 +37,15 @@ class RekordboxAgentRegistry:
         The Rekordbox database instance.
     """
 
-    __update_sequence__ = list()
-    __update_history__ = list()
+    __update_sequence__: List[RegistryUpdateItem] = list()
+    __update_history__: List[RegistryUpdateItem] = list()
     __enabled__ = True
 
-    def __init__(self, db):
+    def __init__(self, db: "Rekordbox6Database") -> None:
         self.db = db
 
     @classmethod
-    def on_update(cls, instance, key, value):
+    def on_update(cls, instance: Instances, key: str, value: Any) -> None:
         """Called when an instance of a database model is updated.
 
         Parameters
@@ -52,7 +62,7 @@ class RekordboxAgentRegistry:
             cls.__update_sequence__.append((instance, "update", key, value))
 
     @classmethod
-    def on_create(cls, instance):
+    def on_create(cls, instance: Instances) -> None:
         """Called when an instance of a database model is created.
 
         Parameters
@@ -65,7 +75,7 @@ class RekordboxAgentRegistry:
             cls.__update_sequence__.append((instance, "create", "", ""))
 
     @classmethod
-    def on_delete(cls, instance):
+    def on_delete(cls, instance: Instances) -> None:
         """Called when an instance of a database model is deleted.
 
         Parameters
@@ -83,7 +93,7 @@ class RekordboxAgentRegistry:
             cls.__update_sequence__.append((instance, "delete", "", ""))
 
     @classmethod
-    def on_move(cls, instances):
+    def on_move(cls, instances: Instances) -> None:
         """Called when instanced of a database model are moved.
 
         Parameters
@@ -96,24 +106,24 @@ class RekordboxAgentRegistry:
             cls.__update_sequence__.append((instances, "move", "", ""))
 
     @classmethod
-    def clear_buffer(cls):
+    def clear_buffer(cls) -> None:
         """Clears the update buffer and update history."""
         cls.__update_history__.extend(cls.__update_sequence__)
         cls.__update_sequence__.clear()
 
     @classmethod
-    def enable_tracking(cls):
+    def enable_tracking(cls) -> None:
         """Enables the tracking of database changes."""
         cls.__enabled__ = True
 
     @classmethod
-    def disable_tracking(cls):
+    def disable_tracking(cls) -> None:
         """Disables the tracking of database changes."""
         cls.__enabled__ = False
 
     @classmethod
     @contextmanager
-    def disabled(cls):
+    def disabled(cls) -> Iterator[Type["RekordboxAgentRegistry"]]:
         """Context manager to temporarily disable the tracking of database changes.
 
         Examples
@@ -132,7 +142,7 @@ class RekordboxAgentRegistry:
         if enabled:
             cls.enable_tracking()
 
-    def get_registries(self):
+    def get_registries(self) -> Any:
         """Returns all agent registries.
 
         Returns
@@ -141,7 +151,7 @@ class RekordboxAgentRegistry:
         """
         return self.db.get_agent_registry()
 
-    def get_registry(self, key):
+    def get_registry(self, key: str) -> Any:
         """Returns the agent registry with the given key.
 
         Parameters
@@ -155,7 +165,7 @@ class RekordboxAgentRegistry:
         """
         return self.db.get_agent_registry(registry_id=key)
 
-    def get_string(self, key):
+    def get_string(self, key: str) -> str:
         """Returns the string value of the registry with the given key.
 
         Parameters
@@ -167,9 +177,10 @@ class RekordboxAgentRegistry:
         -------
         value : str
         """
-        return self.db.get_agent_registry(registry_id=key).str_1
+        reg: "AgentRegistry" = self.db.get_agent_registry(registry_id=key)
+        return reg.str_1
 
-    def get_text(self, key):
+    def get_text(self, key: str) -> str:
         """Returns the text value of the registry with the given key.
 
         Parameters
@@ -181,9 +192,10 @@ class RekordboxAgentRegistry:
         -------
         value : str
         """
-        return self.db.get_agent_registry(registry_id=key).text_1
+        reg: "AgentRegistry" = self.db.get_agent_registry(registry_id=key)
+        return reg.text_1
 
-    def get_int(self, key):
+    def get_int(self, key: str) -> int:
         """Returns the integer value of the registry with the given key.
 
         Parameters
@@ -195,9 +207,10 @@ class RekordboxAgentRegistry:
         -------
         value : int
         """
-        return self.db.get_agent_registry(registry_id=key).int_1
+        reg: "AgentRegistry" = self.db.get_agent_registry(registry_id=key)
+        return reg.int_1
 
-    def get_date(self, key):
+    def get_date(self, key: str) -> datetime:
         """Returns the date value of the registry with the given key.
 
         Parameters
@@ -209,9 +222,10 @@ class RekordboxAgentRegistry:
         -------
         value : datetime.datetime
         """
-        return self.db.get_agent_registry(registry_id=key).date_1
+        reg: "AgentRegistry" = self.db.get_agent_registry(registry_id=key)
+        return reg.date_1
 
-    def set_string(self, key, value):
+    def set_string(self, key: str, value: str) -> None:
         """Sets the string value of the registry with the given key.
 
         Parameters
@@ -223,7 +237,7 @@ class RekordboxAgentRegistry:
         """
         self.db.get_agent_registry(registry_id=key).str_1 = value
 
-    def set_text(self, key, value):
+    def set_text(self, key: str, value: str) -> None:
         """Sets the text value of the registry with the given key.
 
         Parameters
@@ -235,7 +249,7 @@ class RekordboxAgentRegistry:
         """
         self.db.get_agent_registry(registry_id=key).text_1 = value
 
-    def set_int(self, key, value):
+    def set_int(self, key: str, value: int) -> None:
         """Sets the integer value of the registry with the given key.
 
         Parameters
@@ -247,7 +261,7 @@ class RekordboxAgentRegistry:
         """
         self.db.get_agent_registry(registry_id=key).int_1 = value
 
-    def set_date(self, key, value):
+    def set_date(self, key: str, value: datetime) -> None:
         """Sets the date value of the registry with the given key.
 
         Parameters
@@ -259,12 +273,12 @@ class RekordboxAgentRegistry:
         """
         self.db.get_agent_registry(registry_id=key).date_1 = value
 
-    def get_local_update_count(self):
+    def get_local_update_count(self) -> int:
         """Returns the current global local USN (unique sequence number)."""
-        reg = self.db.get_agent_registry(registry_id="localUpdateCount")
+        reg: "AgentRegistry" = self.db.get_agent_registry(registry_id="localUpdateCount")
         return reg.int_1
 
-    def set_local_update_count(self, value):
+    def set_local_update_count(self, value: int) -> None:
         """Sets the global local USN (unique sequence number).
 
         Parameters
@@ -272,10 +286,10 @@ class RekordboxAgentRegistry:
         value : int
             The new USN value.
         """
-        reg = self.db.get_agent_registry(registry_id="localUpdateCount")
+        reg: "AgentRegistry" = self.db.get_agent_registry(registry_id="localUpdateCount")
         reg.int_1 = value
 
-    def increment_local_update_count(self, num=1):
+    def increment_local_update_count(self, num: int = 1) -> int:
         """Increments the global local USN (unique sequence number) by the given number.
 
         Parameters
@@ -290,11 +304,11 @@ class RekordboxAgentRegistry:
         """
         if not isinstance(num, int) or num < 1:
             raise ValueError("The USN can only be increment by a positive integer!")
-        reg = self.db.get_agent_registry(registry_id="localUpdateCount")
+        reg: "AgentRegistry" = self.db.get_agent_registry(registry_id="localUpdateCount")
         reg.int_1 = reg.int_1 + num
         return reg.int_1
 
-    def autoincrement_local_update_count(self, set_row_usn=True):
+    def autoincrement_local_update_count(self, set_row_usn: bool = True) -> int:
         """Auto-increments the global local USN (unique sequence number).
 
         The number of changes in the update buffer is used to determine the
@@ -312,10 +326,10 @@ class RekordboxAgentRegistry:
             The new global local USN.
         """
         reg = self.db.get_agent_registry(registry_id="localUpdateCount")
-        usn = reg.int_1
+        usn: int = reg.int_1
         self.disable_tracking()
         self.db.flush()
-        with self.db.session.no_autoflush:
+        with self.db.no_autoflush:
             for instances, op, _, _ in self.__update_sequence__.copy():
                 usn += 1
                 if set_row_usn:

pyrekordbox/db6/smartlist.py

@@ -7,11 +7,11 @@ import xml.etree.cElementTree as xml
 from dataclasses import dataclass
 from datetime import datetime
 from enum import Enum, IntEnum
-from typing import List, Union
+from typing import Any, Dict, List, Tuple, Union
 
 from dateutil.relativedelta import relativedelta  # noqa
 from sqlalchemy import and_, not_, or_
-from sqlalchemy.sql.elements import BooleanClauseList
+from sqlalchemy.sql.elements import ColumnElement
 
 from .tables import DjmdContent
 
@@ -99,7 +99,7 @@ _DATE_OPS = [
 ]
 
 # Defines the valid operators for each property
-VALID_OPS = {
+VALID_OPS: Dict[str, Any] = {
     Property.ARTIST: _STR_OPS,
     Property.ALBUM: _STR_OPS,
     Property.ALBUM_ARTIST: _STR_OPS,
@@ -126,7 +126,7 @@ VALID_OPS = {
 }
 
 # Defines the column names in the DB for properties that are directly mapped
-PROPERTY_COLUMN_MAP = {
+PROPERTY_COLUMN_MAP: Dict[str, str] = {
     Property.ARTIST: "ArtistName",
     Property.ALBUM: "AlbumName",
     Property.ALBUM_ARTIST: "AlbumArtistName",
@@ -152,7 +152,7 @@ PROPERTY_COLUMN_MAP = {
     Property.YEAR: "ReleaseYear",
 }
 
-TYPE_CONVERSION = {
+TYPE_CONVERSION: Dict[str, Any] = {
     Property.BPM: int,
     Property.STOCK_DATE: lambda x: datetime.strptime(x, "%Y-%m-%d"),
     Property.DATE_CREATED: lambda x: datetime.strptime(x, "%Y-%m-%d"),
@@ -176,7 +176,7 @@ class Condition:
     value_left: Union[str, int]
     value_right: Union[str, int]
 
-    def __post_init__(self):
+    def __post_init__(self) -> None:
         if self.property not in PROPERTIES:
             raise ValueError(
                 f"Invalid property: '{self.property}'! Supported properties: {PROPERTIES}"
@@ -196,15 +196,15 @@ class Condition:
 
 def left_bitshift(x: int, nbit: int = 32) -> int:
     """Left shifts an N bit integer with sign change."""
-    return x - 2**nbit
+    return int(x - 2**nbit)
 
 
 def right_bitshift(x: int, nbit: int = 32) -> int:
     """Right shifts an N bit integer with sign change."""
-    return x + 2**nbit
+    return int(x + 2**nbit)
 
 
-def _get_condition_values(cond):
+def _get_condition_values(cond: Condition) -> Tuple[Any, Any]:
     val_left = cond.value_left
     val_right = cond.value_right
     func = None
@@ -223,7 +223,7 @@ def _get_condition_values(cond):
                 pass
 
     if val_left == "":
-        val_left = None
+        val_left = None  # type: ignore
 
     return val_left, val_right
 
@@ -304,12 +304,12 @@ class SmartList:
         cond = Condition(prop, int(operator), unit, value_left, value_right)
         self.conditions.append(cond)
 
-    def filter_clause(self) -> BooleanClauseList:
+    def filter_clause(self) -> ColumnElement[bool]:
         """Return a SQLAlchemy filter clause matching the content of the smart playlist.
 
         Returns
         -------
-        BooleanClauseList
+        ColumnElement[bool]
             A filter list macthing the contents of the smart playlist.
         """
         logical_op = and_ if self.logical_operator == LogicalOperator.ALL else or_