pydiagral 1.1.0__py3-none-any.whl → 1.1.0b1__py3-none-any.whl

pydiagral/api.py

@@ -134,7 +134,7 @@ class DiagralAPI:
             method (str): The HTTP method to use for the request (e.g., 'GET', 'POST').
             endpoint (str): The API endpoint to send the request to.
             timeout (float, optional): The timeout for the request in seconds. Defaults to 30.
-            **kwargs: Additional keyword arguments to pass to the request.
+            **kwargs (any): Additional keyword arguments to pass to the request.
 
         Returns:
             tuple[dict[str, Any], int]: A tuple containing:
@@ -589,7 +589,6 @@ class DiagralAPI:
         Raises:
             ConfigurationError: If the action is not one of the allowed actions.
             AuthenticationError: If the API key, secret key, or PIN code is missing.
-            All other exceptions from _request function are propagated.
 
         """
 
@@ -643,7 +642,8 @@ class DiagralAPI:
             SystemStatus: An instance of SystemStatus containing the system status after starting the system.
 
         Raises:
-            All exceptions from __system_action function are propagated.
+            ConfigurationError: If the action is not one of the allowed actions.
+            AuthenticationError: If the API key, secret key, or PIN code is missing.
 
         """
 
@@ -658,7 +658,8 @@ class DiagralAPI:
             SystemStatus: An instance of SystemStatus containing the system status after stopping the system.
 
         Raises:
-            All exceptions from __system_action function are propagated.
+            ConfigurationError: If the action is not one of the allowed actions.
+            AuthenticationError: If the API key, secret key, or PIN code is missing.
 
         """
 
@@ -671,7 +672,8 @@ class DiagralAPI:
             SystemStatus: An instance of SystemStatus containing the system status after starting the system in presence mode.
 
         Raises:
-            All exceptions from __system_action function are propagated.
+            ConfigurationError: If the action is not one of the allowed actions.
+            AuthenticationError: If the API key, secret key, or PIN code is missing.
 
         """
 
@@ -688,7 +690,6 @@ class DiagralAPI:
 
         Raises:
             ConfigurationError: If the provided ID is not 1 or 2.
-            All other exceptions from __system_action function are propagated.
 
         """
 
@@ -714,7 +715,6 @@ class DiagralAPI:
         Raises:
             ConfigurationError: If the action is not 'activate_group' or 'disable_group', or if the groups are invalid.
             AuthenticationError: If the API key, secret key, or PIN code is not provided.
-            All other exceptions from _request function are propagated.
 
         """
 
@@ -783,7 +783,7 @@ class DiagralAPI:
 
         Raises:
             ConfigurationError: If the action is not one of the allowed actions.
-            All other exceptions from __action_group_system function are propagated.
+            AuthenticationError: If the API key, secret key, or PIN code is not provided.
 
         """
 
@@ -805,7 +805,7 @@ class DiagralAPI:
 
         Raises:
             ConfigurationError: If the action is not one of the allowed actions.
-            All other exceptions from __action_group_system function are propagated.
+            AuthenticationError: If the API key, secret key, or PIN code is not provided.
 
         """
 
@@ -834,7 +834,6 @@ class DiagralAPI:
         Raises:
             ConfigurationError: If the action is not 'enable' or 'disable', or if the product type is invalid.
             AuthenticationError: If the API key, secret key, or PIN code is not provided.
-            All other exceptions from _request function are propagated.
 
         """
 
@@ -888,7 +887,8 @@ class DiagralAPI:
             SystemStatus: An instance of SystemStatus containing the system status after enabling the product.
 
         Raises:
-            All exceptions from __action_product function are propagated.
+            ConfigurationError: If the action is not 'enable'
+            AuthenticationError: If the API key, secret key, or PIN code is not provided.
 
         """
         return await self.__action_product(
@@ -908,7 +908,8 @@ class DiagralAPI:
             SystemStatus: An instance of SystemStatus containing the system status after disabling the product.
 
         Raises:
-            All exceptions from __action_product function are propagated.
+            ConfigurationError: If the action is not 'disable'
+            AuthenticationError: If the API key, secret key, or PIN code is not provided.
 
         """
         return await self.__action_product(
@@ -980,7 +981,6 @@ class DiagralAPI:
 
         Raises:
             AuthenticationError: If the API key or secret key is not provided.
-            All other exceptions from _request function are propagated.
 
         """
 

pydiagral/models.py

@@ -90,7 +90,7 @@ class CamelCaseModel:
         return result
 
     @classmethod
-    def _from_dict_recursive(cls, data: dict, target_cls: type[T]) -> T:
+    def _from_dict_recursive(cls: type[T], data: dict, target_cls: type[T]) -> T:
         """Recursively converts a dictionary to an instance of the specified target class.
 
         This method handles nested dictionaries and lists, converting them to the appropriate
@@ -98,7 +98,7 @@ class CamelCaseModel:
         by handling `Union` types and removing `None` from the type hints.
 
         Args:
-            cls: The class that this method is a part of.
+            cls (type[T]): The class that this method is a part of.
             data (dict): The dictionary to convert.
             target_cls (type[T]): The target class to convert the dictionary to.
 

{pydiagral-1.1.0.dist-info → pydiagral-1.1.0b1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pydiagral
-Version: 1.1.0
+Version: 1.1.0b1
 Summary: A Python library for interacting with Diagral systems
 Project-URL: Homepage, https://github.com/mguyard/pydiagral
 Project-URL: Documentation, https://github.com/mguyard/pydiagral

pydiagral-1.1.0b1.dist-info/RECORD

@@ -0,0 +1,10 @@
+pydiagral/__init__.py,sha256=4uM-RD2GQ6JYJkxu-D6wj3XpqfY5gN2hP8NF6WvRI9k,576
+pydiagral/api.py,sha256=sX46Fct3Bwei5yKKQ5PnGDKl261BBqZ0CYMFUnXZ5Mw,46753
+pydiagral/constants.py,sha256=2B0TdKxQHA3cpIBxojo43bMW44wN9xKYsHbBRHWsaBk,119
+pydiagral/exceptions.py,sha256=PLo85XJ55q4_dzsyaMYXLIaX8Ws7HH6vDUWNWodzCpM,1013
+pydiagral/models.py,sha256=shnAf7ojh6y5fGp3l5RbGdp4qpuEyOZI-0ePrWAg2l0,54120
+pydiagral/utils.py,sha256=weccW18dseD_Ypwe4dKvNz6TlZPA7BQbf5l5qk3GXOg,444
+pydiagral-1.1.0b1.dist-info/METADATA,sha256=SKmB2a_o7gXGzt2ld9fgmwAPCS_guXTb8hn8k3SOk7w,46570
+pydiagral-1.1.0b1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+pydiagral-1.1.0b1.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+pydiagral-1.1.0b1.dist-info/RECORD,,

pydiagral-1.1.0.dist-info/RECORD

@@ -1,10 +0,0 @@
-pydiagral/__init__.py,sha256=4uM-RD2GQ6JYJkxu-D6wj3XpqfY5gN2hP8NF6WvRI9k,576
-pydiagral/api.py,sha256=hBN2r0OcuPRL9UZJKpaNjF1lozwvZjRL6_QOxB73nY4,46668
-pydiagral/constants.py,sha256=2B0TdKxQHA3cpIBxojo43bMW44wN9xKYsHbBRHWsaBk,119
-pydiagral/exceptions.py,sha256=PLo85XJ55q4_dzsyaMYXLIaX8Ws7HH6vDUWNWodzCpM,1013
-pydiagral/models.py,sha256=pZkEVuvt33rCDm7fUBGFM5jVCwgASzMxNXKAztuqsJ0,54101
-pydiagral/utils.py,sha256=weccW18dseD_Ypwe4dKvNz6TlZPA7BQbf5l5qk3GXOg,444
-pydiagral-1.1.0.dist-info/METADATA,sha256=XPou_Ztx31hTCSOfwy1A_hxCS2Wup7uQdNRhMzVizW0,46568
-pydiagral-1.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-pydiagral-1.1.0.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-pydiagral-1.1.0.dist-info/RECORD,,