Fix return value hints

None is never returned, its just possible that a exception is raised.

Author: Max Ziermann

APIHandler.py

@@ -126,7 +126,7 @@ def set_net_port(self, http_port=80, https_port=443, media_port=9000, onvif_port
         print("Successfully Set Network Ports")
         return True
 
-    def set_wifi(self, ssid, password) -> json or None:
+    def set_wifi(self, ssid, password) -> json:
         body = [{"cmd": "SetWifi", "action": 0, "param": {
             "Wifi": {
                 "ssid": ssid,
@@ -137,10 +137,10 @@ def set_wifi(self, ssid, password) -> json or None:
     ###########
     # GET
     ###########
-    def get_net_ports(self) -> json or None:
+    def get_net_ports(self) -> json:
         """
         Get network ports
-        :return:
+        :return: response json
         """
         body = [{"cmd": "GetNetPort", "action": 1, "param": {}},
                 {"cmd": "GetUpnp", "action": 0, "param": {}},
@@ -162,20 +162,20 @@ def scan_wifi(self):
     ###########
     # GET
     ###########
-    def get_osd(self) -> json or None:
+    def get_osd(self) -> json:
         """
         Get OSD information.
         See examples/response/GetOsd.json for example response data.
-        :return: json or None
+        :return: response json
         """
         body = [{"cmd": "GetOsd", "action": 1, "param": {"channel": 0}}]
         return self._execute_command('GetOsd', body)
 
-    def get_mask(self) -> json or None:
+    def get_mask(self) -> json:
         """
         Get the camera mask information.
         See examples/response/GetMask.json for example response data.
-        :return: json or None
+        :return: response json
         """
         body = [{"cmd": "GetMask", "action": 1, "param": {"channel": 0}}]
         return self._execute_command('GetMask', body)
@@ -195,7 +195,7 @@ def set_osd(self, bg_color: bool = 0, channel: int = 0, osd_channel_enabled: boo
         :param osd_channel_pos: string channel position ["Upper Left","Top Center","Upper Right","Lower Left","Bottom Center","Lower Right"]
         :param osd_time_enabled: bool
         :param osd_time_pos: string time position ["Upper Left","Top Center","Upper Right","Lower Left","Bottom Center","Lower Right"]
-        :return:
+        :return: whether the action was successful
         """
         body = [{"cmd": "SetOsd", "action": 1, "param": {
             "Osd": {"bgcolor": bg_color, "channel": channel,
@@ -217,35 +217,36 @@ def set_osd(self, bg_color: bool = 0, channel: int = 0, osd_channel_enabled: boo
     ###########
     # GET
     ###########
-    def get_general_system(self) -> json or None:
+    def get_general_system(self) -> json:
+        """:return: response json"""
         body = [{"cmd": "GetTime", "action": 1, "param": {}}, {"cmd": "GetNorm", "action": 1, "param": {}}]
         return self._execute_command('get_general_system', body, multi=True)
 
-    def get_performance(self) -> json or None:
+    def get_performance(self) -> json:
         """
         Get a snapshot of the current performance of the camera.
         See examples/response/GetPerformance.json for example response data.
-        :return: json or None
+        :return: response json
         """
         body = [{"cmd": "GetPerformance", "action": 0, "param": {}}]
         return self._execute_command('GetPerformance', body)
 
-    def get_information(self) -> json or None:
+    def get_information(self) -> json:
         """
         Get the camera information
         See examples/response/GetDevInfo.json for example response data.
-        :return: json or None
+        :return: response json
         """
         body = [{"cmd": "GetDevInfo", "action": 0, "param": {}}]
         return self._execute_command('GetDevInfo', body)
 
     ###########
     # SET
     ###########
-    def reboot_camera(self) -> bool:
+    def reboot_camera(self) -> json:
         """
         Reboots the camera
-        :return: bool
+        :return: response json
         """
         body = [{"cmd": "Reboot", "action": 0, "param": {}}]
         return self._execute_command('Reboot', body)
@@ -257,20 +258,20 @@ def reboot_camera(self) -> bool:
     ##########
     # GET
     ##########
-    def get_online_user(self) -> json or None:
+    def get_online_user(self) -> json:
         """
         Return a list of current logged-in users in json format
         See examples/response/GetOnline.json for example response data.
-        :return: json or None
+        :return: response json
         """
         body = [{"cmd": "GetOnline", "action": 1, "param": {}}]
         return self._execute_command('GetOnline', body)
 
-    def get_users(self) -> json or None:
+    def get_users(self) -> json:
         """
         Return a list of user accounts from the camera in json format.
         See examples/response/GetUser.json for example response data.
-        :return: json or None
+        :return: response json
         """
         body = [{"cmd": "GetUser", "action": 1, "param": {}}]
         return self._execute_command('GetUser', body)
@@ -284,7 +285,7 @@ def add_user(self, username: str, password: str, level: str = "guest") -> bool:
         :param username: The user's username
         :param password: The user's password
         :param level: The privilege level 'guest' or 'admin'. Default is 'guest'
-        :return: bool
+        :return: whether the user was added successfully
         """
         body = [{"cmd": "AddUser", "action": 0,
                  "param": {"User": {"userName": username, "password": password, "level": level}}}]
@@ -299,7 +300,7 @@ def modify_user(self, username: str, password: str) -> bool:
         Modify the user's password by specifying their username
         :param username: The user which would want to be modified
         :param password: The new password
-        :return: bool
+        :return: whether the user was modified successfully
         """
         body = [{"cmd": "ModifyUser", "action": 0, "param": {"User": {"userName": username, "password": password}}}]
         r_data = self._execute_command('ModifyUser', body)
@@ -312,7 +313,7 @@ def delete_user(self, username: str) -> bool:
         """
         Delete a user by specifying their username
         :param username: The user which would want to be deleted
-        :return: bool
+        :return: whether the user was deleted successfully
         """
         body = [{"cmd": "DelUser", "action": 0, "param": {"User": {"userName": username}}}]
         r_data = self._execute_command('DelUser', body)
@@ -352,11 +353,11 @@ def get_snap(self, timeout: int = 3) -> Image or None:
     #########
     # Device
     #########
-    def get_hdd_info(self) -> json or None:
+    def get_hdd_info(self) -> json:
         """
         Gets all HDD and SD card information from Camera
         See examples/response/GetHddInfo.json for example response data.
-        :return: json or None
+        :return: response json
         """
         body = [{"cmd": "GetHddInfo", "action": 0, "param": {}}]
         return self._execute_command('GetHddInfo', body)
@@ -385,20 +386,20 @@ def format_hdd(self, hdd_id: [int] = [0]) -> bool:
     ###########
     # GET
     ###########
-    def get_recording_encoding(self) -> json or None:
+    def get_recording_encoding(self) -> json:
         """
         Get the current camera encoding settings for "Clear" and "Fluent" profiles.
         See examples/response/GetEnc.json for example response data.
-        :return: json or None
+        :return: response json
         """
         body = [{"cmd": "GetEnc", "action": 1, "param": {"channel": 0}}]
         return self._execute_command('GetEnc', body)
 
-    def get_recording_advanced(self) -> json or None:
+    def get_recording_advanced(self) -> json:
         """
         Get recording advanced setup data
         See examples/response/GetRec.json for example response data.
-        :return: json or None
+        :return: response json
         """
         body = [{"cmd": "GetRec", "action": 1, "param": {"channel": 0}}]
         return self._execute_command('GetRec', body)