torrt 1.1.0__py3-none-any.whl

torrt/__init__.py

@@ -0,0 +1,3 @@
+
+VERSION = '1.1.0'
+"""Application version string."""

torrt/base_bot.py

@@ -0,0 +1,31 @@
+from .exceptions import TorrtBotException
+from .utils import BotClassesRegistry, BotObjectsRegistry, WithSettings
+
+
+class BaseBot(WithSettings):
+
+    config_entry_name: str = 'bots'
+
+    def __init_subclass__(cls, **kwargs):
+        if cls.alias:
+            BotClassesRegistry.add(cls)
+
+    def register(self):
+        """Adds this object intoBotObjectsRegistry."""
+
+        BotObjectsRegistry.add(self)
+
+    def test_configuration(self) -> bool:
+        """This should implement a configuration test, for example check given credentials."""
+        return False
+
+    def run(self):
+        """Run bot to receive incoming commands."""
+
+class BotRegistrationFailed(TorrtBotException):
+
+    """Bot is failed to register (missing dependency or precondition)
+
+    This exception must be raised during bot class construction
+
+    """

torrt/base_notifier.py

@@ -0,0 +1,46 @@
+from .utils import NotifierClassesRegistry, NotifierObjectsRegistry, WithSettings
+
+
+class BaseNotifier(WithSettings):
+    """Base Notifier class. All Notifier classes should inherit from this."""
+
+    config_entry_name: str = 'notifiers'
+
+    def __init_subclass__(cls, **kwargs):
+        if cls.alias:
+            NotifierClassesRegistry.add(cls)
+
+    def register(self):
+        """Adds this object into NotificationObjectsRegistry."""
+
+        NotifierObjectsRegistry.add(self)
+
+    def send_message(self, msg: str):  # pragma: nocover
+        """Send prepared message
+
+        :param msg: Prepared by notifier backend message
+
+        """
+        raise NotImplementedError
+
+    def make_message(self, torrent_data: dict) -> str:  # pragma: nocover
+        """Creates message in format suitable for notifier backend
+
+        :param: torrent_data: dictionary with updated torrents data during the walk operation
+
+        """
+        raise NotImplementedError
+
+    def test_configuration(self) -> bool:
+        """This should implement a configuration test, for example check given credentials."""
+
+        return False
+
+    def send(self, updated_data):
+        """Send message to user
+
+        :param: updated_data: dict - dictionary with updated torrents data during the walk operation
+
+        """
+        msg = self.make_message(updated_data)
+        self.send_message(msg)

torrt/base_rpc.py

@@ -0,0 +1,83 @@
+from typing import Any, ClassVar
+
+from .utils import HttpClient, RPCClassesRegistry, RPCObjectsRegistry, TorrentData, WithSettings
+
+
+class BaseRPC(WithSettings):
+    """Base RPC class. All RPC classes should inherit from this."""
+
+    config_entry_name: str = 'rpc'
+
+    torrent_fields_map: ClassVar[dict[str, str]] = {}
+    """mapping from torrent fields names in terms of RPC to field names in term of torrt"""
+
+    enabled: bool = False
+
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+
+        self.client = HttpClient(
+            silence_exceptions=True,
+            dump_fname_tpl=f'%(ts)s_{self.__class__.__name__}.json',
+            tunnel=False,
+            json=True,
+        )
+        self.logged_in = False
+
+    def __init_subclass__(cls, **kwargs):
+        if cls.alias:
+            RPCClassesRegistry.add(cls)
+
+    def register(self):
+        """Adds this object into RPCObjectsRegistry."""
+
+        RPCObjectsRegistry.add(self)
+
+    @classmethod
+    def normalize_field_names(cls, torrent_info: dict):
+        """Translates from torrent fields names in terms of RPC to field names in term of torrt.
+        Updates accordingly a given torrent_info inplace.
+
+        :param torrent_info:
+
+        """
+        for old_name, new_name in cls.torrent_fields_map.items():
+            if old_name in torrent_info:
+                torrent_info[new_name] = torrent_info[old_name]
+
+    def method_get_torrents(self, hashes: list[str] | None = None) -> list[dict]:  # pragma: nocover
+        """This should return a dictionary with torrents info from RPC.
+        Each torrent info should be normalized (see normalize_field_names()).
+
+        :param hashes: torrent hashes
+
+        """
+        raise NotImplementedError
+
+    def method_add_torrent(
+            self, torrent: TorrentData, *, download_to: str = '', params: dict | None = None) -> Any:  # pragma: nocover
+        """Adds torrent to torrent client using RPC.
+
+        :param torrent: torrent info
+        :param download_to: path to download files from torrent into (in terms of torrent client filesystem)
+        :param params: optional information attached to torrent that should be preserved
+
+        """
+        raise NotImplementedError
+
+    def method_remove_torrent(self, hash_str: str, *, with_data: bool = False) -> Any:  # pragma: nocover
+        """Removes torrent from torrent client using RPC.
+
+        :param hash_str: torrent identifying hash
+        :param with_data: flag to also remove files from torrent
+
+        """
+        raise NotImplementedError
+
+    def method_get_version(self) -> str:  # pragma: nocover
+        """Returns torrent client API version."""
+        raise NotImplementedError
+
+    def test_configuration(self) -> str:
+        # This is to conform to common interface.
+        return self.method_get_version()