adding connection timeout in secs with default value 10 secs (#179)

Allow for the setting of a custom timeout for all requests --------- Co-authored-by: Dinculescu <[email protected]>
mihai-dinculescu · Mar 29, 2024 · 8baead0 · 8baead0
1 parent d0fd53a
commit 8baead0
Show file tree

Hide file tree

Showing 4 changed files with 50 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,9 +10,15 @@ file. This change log follows the conventions of
 
 - The implementation of `ApiClient::new` has been improved to allow for the return of `ApiClient` instead of `Result<ApiClient, Error>`.
 - The default timeout for all requests has been reduced to 30 seconds from 300 seconds.
+- `ApiClient::with_timeout` has been added to allow for the setting of a custom timeout for all requests (thanks to @skoky).
 
 ## [Python Unreleased][Unreleased]
 
+### Changed
+
+- The default timeout for all requests has been reduced to 30 seconds from 300 seconds.
+- The `timeout_s` optional parameter has been added to the `ApiClient` constructor to allow for the setting of a custom timeout for all requests (thanks to @skoky).
+
 ## [Rust v0.7.9][v0.7.9] - 2024-01-27
 
 ### Changed

diff --git a/tapo-py/src/api_client.rs b/tapo-py/src/api_client.rs
@@ -1,4 +1,5 @@
 use pyo3::prelude::*;
+use std::time::Duration;
 use tapo::ApiClient;
 
 use crate::errors::ErrorWrapper;
@@ -15,8 +16,17 @@ pub struct PyApiClient {
 #[pymethods]
 impl PyApiClient {
     #[new]
-    pub fn new(tapo_username: String, tapo_password: String) -> Result<Self, ErrorWrapper> {
-        let client = ApiClient::new(tapo_username, tapo_password);
+    pub fn new(
+        tapo_username: String,
+        tapo_password: String,
+        timeout_s: Option<u64>,
+    ) -> Result<Self, ErrorWrapper> {
+        let client = match timeout_s {
+            Some(timeout_s) => ApiClient::new(tapo_username, tapo_password)
+                .with_timeout(Duration::from_secs(timeout_s)),
+            None => ApiClient::new(tapo_username, tapo_password),
+        };
+
         Ok(Self { client })
     }
 

diff --git a/tapo-py/tapo-py/tapo/api_client.pyi b/tapo-py/tapo-py/tapo/api_client.pyi
@@ -21,11 +21,12 @@ Example:
 See [more examples](https://github.com/mihai-dinculescu/tapo/tree/main/tapo-py/examples).
 """
 
+from typing import Optional
+from .color_light_handler import ColorLightHandler
 from .generic_device_handler import GenericDeviceHandler
 from .light_handler import LightHandler
-from .color_light_handler import ColorLightHandler
-from .plug_handler import PlugHandler
 from .plug_energy_monitoring_handler import PlugEnergyMonitoringHandler
+from .plug_handler import PlugHandler
 
 class ApiClient:
     """Tapo API Client.
@@ -51,12 +52,13 @@ class ApiClient:
     See [more examples](https://github.com/mihai-dinculescu/tapo/tree/main/tapo-py/examples).
     """
 
-    def __init__(self, tapo_username: str, tapo_password: str) -> None:
+    def __init__(self, tapo_username: str, tapo_password: str, timeout_s: int = 30) -> None:
         """Returns a new instance of `ApiClient`.
 
         Args:
-            tapo_username (str): The Tapo username
-            tapo_password (str): The Tapo password
+            tapo_username (str): The Tapo username.
+            tapo_password (str): The Tapo password.
+            timeout_s (int): The connection timeout in seconds. The default value is 30 seconds.
 
         Returns:
             ApiClient: Tapo API Client.
@@ -79,6 +81,7 @@ class ApiClient:
 
         See [more examples](https://github.com/mihai-dinculescu/tapo/tree/main/tapo-py/examples).
         """
+
     async def generic_device(self, ip_address: str) -> GenericDeviceHandler:
         """Specializes the given `ApiClient` into an authenticated `GenericDeviceHandler`.
 
@@ -97,6 +100,7 @@ class ApiClient:
             await device.on()
             ```
         """
+
     async def l510(self, ip_address: str) -> LightHandler:
         """Specializes the given `ApiClient` into an authenticated `LightHandler`.
 
@@ -114,6 +118,7 @@ class ApiClient:
             await device.on()
             ```
         """
+
     async def l520(self, ip_address: str) -> LightHandler:
         """Specializes the given `ApiClient` into an authenticated `LightHandler`.
 
@@ -131,6 +136,7 @@ class ApiClient:
             await device.on()
             ```
         """
+
     async def l530(self, ip_address: str) -> ColorLightHandler:
         """Specializes the given `ApiClient` into an authenticated `ColorLightHandler`.
 
@@ -148,6 +154,7 @@ class ApiClient:
             await device.on()
             ```
         """
+
     async def l610(self, ip_address: str) -> LightHandler:
         """Specializes the given `ApiClient` into an authenticated `LightHandler`.
 
@@ -165,6 +172,7 @@ class ApiClient:
             await device.on()
             ```
         """
+
     async def l630(self, ip_address: str) -> ColorLightHandler:
         """Specializes the given `ApiClient` into an authenticated `ColorLightHandler`.
 
@@ -182,6 +190,7 @@ class ApiClient:
             await device.on()
             ```
         """
+
     async def l900(self, ip_address: str) -> ColorLightHandler:
         """Specializes the given `ApiClient` into an authenticated `ColorLightHandler`.
 
@@ -199,6 +208,7 @@ class ApiClient:
             await device.on()
             ```
         """
+
     async def p100(self, ip_address: str) -> PlugHandler:
         """Specializes the given `ApiClient` into an authenticated `PlugHandler`.
 
@@ -216,6 +226,7 @@ class ApiClient:
             await device.on()
             ```
         """
+
     async def p105(self, ip_address: str) -> PlugHandler:
         """Specializes the given `ApiClient` into an authenticated `PlugHandler`.
 
@@ -233,6 +244,7 @@ class ApiClient:
             await device.on()
             ```
         """
+
     async def p110(self, ip_address: str) -> PlugEnergyMonitoringHandler:
         """Specializes the given `ApiClient` into an authenticated `PlugEnergyMonitoringHandler`.
 
@@ -250,6 +262,7 @@ class ApiClient:
             await device.on()
             ```
         """
+
     async def p115(self, ip_address: str) -> PlugEnergyMonitoringHandler:
         """Specializes the given `ApiClient` into an authenticated `PlugEnergyMonitoringHandler`.
 

diff --git a/tapo/src/api/api_client.rs b/tapo/src/api/api_client.rs
@@ -60,13 +60,16 @@ pub struct ApiClient {
 /// Tapo API Client constructor.
 impl ApiClient {
     /// Returns a new instance of [`ApiClient`].
-    /// It it cheaper to [`ApiClient::clone`] an existing instance than to create a new one when multiple devices need to be controller.
+    /// It is cheaper to [`ApiClient::clone`] an existing instance than to create a new one when multiple devices need to be controller.
     /// This is because [`ApiClient::clone`] reuses the underlying [`isahc::HttpClient`] and [`openssl::rsa::Rsa`] key.
     ///
     /// # Arguments
     ///
     /// * `tapo_username` - the Tapo username
     /// * `tapo_password` - the Tapo password
+    ///
+    /// Note: The default connection timeout is 30 seconds.
+    /// Use [`ApiClient::with_timeout`] to change it.
     pub fn new(tapo_username: impl Into<String>, tapo_password: impl Into<String>) -> ApiClient {
         Self {
             tapo_username: tapo_username.into(),
@@ -75,6 +78,16 @@ impl ApiClient {
             protocol: None,
         }
     }
+
+    /// Changes the connection timeout from the default value to the given value.
+    ///
+    /// # Arguments
+    ///
+    /// * `timeout` - The new connection timeout value.
+    pub fn with_timeout(mut self, timeout: Duration) -> ApiClient {
+        self.timeout = Some(timeout);
+        self
+    }
 }
 
 /// Device handler builders.