Type universal_search.py

synology_api/universal_search.py

@@ -1,21 +1,33 @@
+from typing import Optional
 from synology_api import auth
 from urllib import parse
 
 
 class UniversalSearch:
-	def __init__(self, ip_address, port, username, password, secure=False, cert_verify=False, dsm_version=7, debug=True, otp_code=None):
-		self.session = auth.Authentication(ip_address, port, username, password, secure, cert_verify, dsm_version, debug, otp_code)
+    def __init__(self,
+                    ip_address: str,
+                    port: str,
+                    username: str,
+                    password: str,
+                    secure: bool = False,
+                    cert_verify: bool = False,
+                    dsm_version: int = 7,
+                    debug: bool = True,
+                    otp_code: Optional[str] = None
+                ) -> None:
+        self.session : auth.Authentication = auth.Authentication(ip_address, port, username, password, secure, cert_verify, dsm_version, debug, otp_code)
         self.session.login('Finder')
         self.session.get_api_list('Finder')
-		self.request_data = self.session.request_data
-		self.finder_list = self.session.app_api_list
-		self._sid = self.session.sid
-		self.base_url = self.session.base_url
+        self.request_data : function = self.session.request_data
+        self.finder_list : dict[str, object] = self.session.app_api_list
+        self._sid : str = self.session.sid
+        self.base_url : str = self.session.base_url
 
-	def logout(self):
+    def logout(self) -> None:
         self.session.logout('FileStation')
+        return
 
-	def search(self, keyword):
+    def search(self, keyword:str) -> dict[str, object]:
         api_name = 'SYNO.Finder.FileIndexing.Search'
         info = self.finder_list[api_name]
         api_path = info['path']