Merge pull request ManiMatter#346 from eadgbear/eadgbear/timeout_fix

[NEEDS CODE REVIEWER] (time-out related) Adding timeout property to instances.

Author: jrhager84

.github/workflows/build.yml

@@ -57,6 +57,9 @@ jobs:
     needs: unit-tests
     runs-on: ubuntu-latest
     if: github.event_name == 'push'
+    permissions:
+      contents: read
+      packages: write
     steps:
       - uses: actions/checkout@v4
         with:

config/config_example.yaml

@@ -5,6 +5,7 @@ general:
   # request_timeout: 15 # Optional: timeout for all HTTP/API calls in seconds
   # ignored_download_clients: ["emulerr"]
   # ssl_verification: false # Optional: Defaults to true
+  # request_timeout: 15 # Optional: Request timeout in seconds. Defaults to 15. Can be overridden per instance.
   # private_tracker_handling: "obsolete_tag" # remove, skip, obsolete_tag. Optional. Default: remove
   # public_tracker_handling: "remove"  # remove, skip, obsolete_tag. Optional. Default: remove
   # obsolete_tag: "Obsolete" # optional. Default: "Obsolete"
@@ -53,6 +54,7 @@ instances:
   sonarr:
     - base_url: "http://sonarr:8989"
       api_key: "xxxx"
+      # timeout: 30 # Optional: Overrides general timeout for this instance.
   radarr:
     - base_url: "http://radarr:7878"
       api_key: "xxxx"
@@ -72,6 +74,7 @@ download_clients:
       # username: xxxx # (optional -> if not provided, assuming not needed)
       # password: xxxx # (optional -> if not provided, assuming not needed)
       # name: "qBittorrent" # (optional -> if not provided, assuming "qBittorrent". Must correspond with what is specified in your *arr as download client name)
+      # timeout: 30 # (optional -> overrides general timeout for this instance)
   # sabnzbd:
   #   - base_url: "http://sabnzbd:8080" # SABnzbd server URL
   #     api_key: "your_api_key_here" # (required -> SABnzbd API key)

src/settings/_download_clients_qbit.py

@@ -47,8 +47,10 @@ def __init__(
         username: str = None,
         password: str = None,
         name: str = None,
+        timeout: int | None = None,
     ):
         self.settings = settings
+        self._timeout = timeout
         if not base_url:
             logger.error("Skipping qBittorrent client entry: 'base_url' is required.")
             error = "qBittorrent client must have a 'base_url'."
@@ -68,6 +70,13 @@ def __init__(
 
         self._remove_none_attributes()
 
+    @property
+    def timeout(self):
+        instance_timeout = getattr(self, "_timeout", None)
+        if instance_timeout is not None:
+            return instance_timeout
+        return getattr(getattr(self.settings, "general", None), "request_timeout", 15)
+
     def _remove_none_attributes(self):
         """Remove attributes that are None to keep the object clean."""
         for attr in list(vars(self)):
@@ -95,6 +104,7 @@ def _connection_error():
                 "post",
                 endpoint,
                 self.settings,
+                timeout=self.timeout,
                 data=data,
                 headers=headers,
                 ignore_test_run=True,
@@ -133,6 +143,7 @@ async def fetch_version(self):
             "get",
             endpoint,
             self.settings,
+            timeout=self.timeout,
             cookies=self.cookie,
         )
         self.version = response.text[1:]  # Remove the '_v' prefix
@@ -161,7 +172,7 @@ async def create_tag(self, tag: str):
             "_download_clients_qBit.py/create_tag: Checking if tag '{tag}' exists (and creating it if not)",
         )
         url = f"{self.api_url}/torrents/tags"
-        response = await make_request("get", url, self.settings, cookies=self.cookie)
+        response = await make_request("get", url, self.settings, timeout=self.timeout, cookies=self.cookie)
         current_tags = response.json()
 
         if tag not in current_tags:
@@ -171,6 +182,7 @@ async def create_tag(self, tag: str):
                 "post",
                 self.api_url + "/torrents/createTags",
                 self.settings,
+                timeout=self.timeout,
                 data=data,
                 cookies=self.cookie,
             )
@@ -196,6 +208,7 @@ async def set_unwanted_folder(self):
                 "get",
                 endpoint,
                 self.settings,
+                timeout=self.timeout,
                 cookies=self.cookie,
             )
             qbit_settings = response.json()
@@ -209,6 +222,7 @@ async def set_unwanted_folder(self):
                     "post",
                     self.api_url + "/app/setPreferences",
                     self.settings,
+                    timeout=self.timeout,
                     data=data,
                     cookies=self.cookie,
                 )
@@ -229,6 +243,7 @@ async def check_qbit_reachability(self):
                 "post",
                 endpoint,
                 self.settings,
+                timeout=self.timeout,
                 data=data,
                 headers=headers,
                 log_error=False,
@@ -251,6 +266,7 @@ async def check_connected(self):
                     "get",
                     self.api_url + "/sync/maindata",
                     self.settings,
+                    timeout=self.timeout,
                     cookies=self.cookie,
                 )
             ).json()
@@ -353,6 +369,7 @@ async def set_tag(self, tags, hashes):
             "post",
             self.api_url + "/torrents/addTags",
             self.settings,
+            timeout=self.timeout,
             data=data,
             cookies=self.cookie,
         )
@@ -376,6 +393,7 @@ async def get_qbit_items(self, hashes: list[str] | str | None = None) -> list[di
             method="get",
             endpoint=f"{self.api_url}/torrents/info",
             settings=self.settings,
+            timeout=self.timeout,
             params=None,  # Retrieve all torrents
             cookies=self.cookie,
         )
@@ -395,12 +413,13 @@ async def get_qbit_items(self, hashes: list[str] | str | None = None) -> list[di
     async def get_torrent_properties(self, qbit_hash):
         params = {"hash": qbit_hash.lower()}
         response = await make_request(
-                        "get",
-                        self.api_url + "/torrents/properties",
-                        self.settings,
-                        params=params,
-                        cookies=self.cookie,
-                    )
+            "get",
+            self.api_url + "/torrents/properties",
+            self.settings,
+            timeout=self.timeout,
+            params=params,
+            cookies=self.cookie,
+        )
         return response.json()
 
 
@@ -411,6 +430,7 @@ async def get_torrent_files(self, download_id):
             method="get",
             endpoint=self.api_url + "/torrents/files",
             settings=self.settings,
+            timeout=self.timeout,
             params={"hash": download_id.lower()},
             cookies=self.cookie,
         )
@@ -429,6 +449,7 @@ async def set_torrent_file_priority(self, download_id, file_id, priority=0):
             "post",
             self.api_url + "/torrents/filePrio",
             self.settings,
+            timeout=self.timeout,
             data=data,
             cookies=self.cookie,
         )
@@ -440,6 +461,7 @@ async def set_bandwidth_usage(self):
             method="get",
             endpoint=self.api_url + "/transfer/info",
             settings=self.settings,
+            timeout=self.timeout,
             cookies=self.cookie,
         )
         records = extract_json_from_response(response)
@@ -476,6 +498,7 @@ async def remove_download(self, download_hash: str, delete_files: bool = True):
             "post",
             f"{self.api_url}/torrents/delete",
             self.settings,
+            timeout=self.timeout,
             data=data,
             cookies=self.cookie,
         )

src/settings/_download_clients_sabnzbd.py

@@ -43,8 +43,10 @@ def __init__(
         base_url: str = None,
         api_key: str = None,
         name: str = None,
+        timeout: int | None = None,
     ):
         self.settings = settings
+        self._timeout = timeout
         if not base_url:
             logger.error("Skipping SABnzbd client entry: 'base_url' is required.")
             error = "SABnzbd client must have a 'base_url'."
@@ -68,6 +70,13 @@ def __init__(
 
         self._remove_none_attributes()
 
+    @property
+    def timeout(self):
+        instance_timeout = getattr(self, "_timeout", None)
+        if instance_timeout is not None:
+            return instance_timeout
+        return getattr(getattr(self.settings, "general", None), "request_timeout", 15)
+
     def _remove_none_attributes(self):
         """Remove attributes that are None to keep the object clean."""
         for attr in list(vars(self)):
@@ -80,7 +89,7 @@ async def fetch_version(self):
             "_download_clients_sabnzbd.py/fetch_version: Getting SABnzbd Version"
         )
         params = {"mode": "version", "apikey": self.api_key, "output": "json"}
-        response = await make_request("get", self.api_url, self.settings, params=params)
+        response = await make_request("get", self.api_url, self.settings, timeout=self.timeout, params=params)
         response_data = response.json()
         self.version = response_data.get("version", "unknown")
         logger.debug(
@@ -109,6 +118,7 @@ async def check_sabnzbd_reachability(self):
                 "get",
                 self.api_url,
                 self.settings,
+                timeout=self.timeout,
                 params=params,
                 log_error=False,
                 ignore_test_run=True,
@@ -129,6 +139,7 @@ async def check_connected(self):
             "get",
             self.api_url,
             self.settings,
+            timeout=self.timeout,
             params=params,
         )
         status_data = response.json()
@@ -160,6 +171,7 @@ async def get_queue_items(self):
             "get",
             self.api_url,
             self.settings,
+            timeout=self.timeout,
             params=params,
         )
         queue_data = response.json()
@@ -175,6 +187,7 @@ async def get_history_items(self):
             "get",
             self.api_url,
             self.settings,
+            timeout=self.timeout,
             params=params,
         )
         history_data = response.json()
@@ -196,6 +209,7 @@ async def remove_download(self, nzo_id: str):
             "get",
             self.api_url,
             self.settings,
+            timeout=self.timeout,
             params=params,
         )
 
@@ -215,6 +229,7 @@ async def pause_download(self, nzo_id: str):
             "get",
             self.api_url,
             self.settings,
+            timeout=self.timeout,
             params=params,
         )
 
@@ -234,6 +249,7 @@ async def resume_download(self, nzo_id: str):
             "get",
             self.api_url,
             self.settings,
+            timeout=self.timeout,
             params=params,
         )
 
@@ -252,6 +268,7 @@ async def retry_download(self, nzo_id: str):
             "get",
             self.api_url,
             self.settings,
+            timeout=self.timeout,
             params=params,
         )
 
@@ -308,6 +325,7 @@ async def get_download_speed(self):
             "get",
             self.api_url,
             self.settings,
+            timeout=self.timeout,
             params=params,
         )
         status_data = response.json()

src/settings/_general.py

@@ -13,6 +13,7 @@ class General:
     timer: float = 10.0
     request_timeout: float = 15.0
     ssl_verification: bool = True
+    request_timeout: int = 15
     ignored_download_clients: list = []
     private_tracker_handling: str = "remove"
     public_tracker_handling: str = "remove"
@@ -30,6 +31,7 @@ def __init__(self, config):
         self.ssl_verification = general_config.get(
             "ssl_verification", self.ssl_verification
         )
+        self.request_timeout = general_config.get("request_timeout", self.request_timeout)
         self.ignored_download_clients = general_config.get(
             "ignored_download_clients", self.ignored_download_clients
         )