ihcsdk 2.8.6__py3-none-any.whl → 2.8.8__py3-none-any.whl

ihcsdk/ihcclient.py

@@ -1,6 +1,7 @@
 """
 Implements the connection to the ihc controller
 """
+
 # pylint: disable=bare-except
 import base64
 import datetime
@@ -112,14 +113,17 @@ class IHCSoapClient:
         """Get the ihc project per segments.
         Param: info .. reuse existing project info. If not provided, the get_project_info() is called internally.
         """
-        if info == None:
+        if info is None:
             info = self.get_project_info()
         if info:
             projectMajor = info.get("projectMajorRevision", 0)
             projectMinor = info.get("projectMinorRevision", 0)
             buffer = io.BytesIO()
             for s in range(self.get_project_number_of_segments()):
-                buffer.write(self.get_project_segment(s, projectMajor, projectMinor))
+                segment = self.get_project_segment(s, projectMajor, projectMinor)
+                if segment is False:
+                    return False
+                buffer.write(segment)
             return zlib.decompress(buffer.getvalue(), 16 + zlib.MAX_WBITS).decode(
                 "ISO-8859-1"
             )
@@ -342,32 +346,31 @@ class IHCSoapClient:
 
     def __get_value(resource_value):
         """Get a runtime value from the xml base on the type in the xml"""
-        if resource_value == None:
+        if resource_value is None:
             return None
         valuetype = resource_value.attrib[
             "{http://www.w3.org/2001/XMLSchema-instance}type"
         ].split(":")[1]
-        default_fn = lambda v: v.text
-        result = {
-            "WSBooleanValue": lambda v: (
-                v.find("./ns2:value", IHCSoapClient.ihcns).text == "true"
-            ),
-            "WSIntegerValue": lambda v: int(
-                v.find("./ns2:integer", IHCSoapClient.ihcns).text
-            ),
-            "WSFloatingPointValue": lambda v: round( 
-                float( v.find("./ns2:floatingPointValue", IHCSoapClient.ihcns).text),2
-            ),
-            "WSEnumValue": lambda v: v.find("./ns2:enumName", IHCSoapClient.ihcns).text,
-            "WSTimerValue": lambda v: int(
-                v.find("./ns2:milliseconds", IHCSoapClient.ihcns).text
-            ),
-            "WSTimeValue": lambda v: IHCSoapClient.get_time(v),
-            "WSDate": lambda v: IHCSoapClient.get_datetime(v),
-            "WSDateValue": lambda v: IHCSoapClient.get_date(v),
-            "int": lambda v: int(v.text),
-        }.get(valuetype, default_fn)(resource_value)
-
+        result = resource_value.text
+        match valuetype:
+            case "WSBooleanValue":
+                result = resource_value.find("./ns2:value", IHCSoapClient.ihcns).text == "true"
+            case "WSIntegerValue":
+                result = resource_value.find("./ns2:integer", IHCSoapClient.ihcns).text
+            case "WSFloatingPointValue":
+                result = round(float(resource_value.find("./ns2:floatingPointValue", IHCSoapClient.ihcns).text), 2)
+            case "WSEnumValue":
+                result = resource_value.find("./ns2:enumName", IHCSoapClient.ihcns).text
+            case "WSTimerValue":
+                return int(resource_value.find("./ns2:milliseconds", IHCSoapClient.ihcns).text)
+            case "WSTimeValue":
+                result = IHCSoapClient.get_time(resource_value)
+            case "WSDate":
+                result = IHCSoapClient.get_datetime(resource_value)
+            case "WSDateValue":
+                result = IHCSoapClient.get_date(resource_value)
+            case "int":
+                result = int(resource_value.text)
         return result
 
     def get_runtime_value(self, resourceid: int):
@@ -476,7 +479,7 @@ class IHCSoapClient:
         if change_list is False:
             return False
         last_changes = {}
-        for (id, value) in change_list:
+        for id, value in change_list:
             last_changes[id] = value
         return last_changes
 
@@ -533,9 +536,7 @@ class IHCSoapClient:
 
     def clear_user_log(self):
         """Clear the user log in the controller"""
-        xdoc = self.connection.soap_action(
-            "/ws/ConfigurationService", "clearUserLog", ""
-        )
+        self.connection.soap_action("/ws/ConfigurationService", "clearUserLog", "")
         return
 
     def get_system_info(self):

ihcsdk/ihcconnection.py

@@ -1,13 +1,17 @@
 """Implements soap reqeust using the "requests" module"""
+
 # pylint: disable=too-few-public-methods
 import logging
 import requests
 import xml.etree.ElementTree
 
 from urllib.parse import urlparse
+from urllib3.util import Retry
+from requests.adapters import HTTPAdapter
 
 _LOGGER = logging.getLogger(__name__)
 
+
 class IHCConnection(object):
     """Implements a http connection to the controller"""
 
@@ -24,6 +28,13 @@ class IHCConnection(object):
         self.last_exception = None
         self.last_response = None
         self.session = requests.Session()
+        self.retries = Retry(
+            total=3,
+            backoff_factor=0.2,
+            status_forcelist=[502, 503, 504],
+            allowed_methods={"POST"},
+        )
+        self.session.mount("http://", HTTPAdapter(max_retries=self.retries))
 
     def cert_verify(self):
         return None
@@ -39,7 +50,7 @@ class IHCConnection(object):
             "SOAPAction": action,
         }
         try:
-            _LOGGER.debug( "soap payload %s",payload)
+            _LOGGER.debug("soap payload %s", payload)
             self.last_exception = None
             response = self.session.post(
                 url=self.url + service,
@@ -47,22 +58,20 @@ class IHCConnection(object):
                 data=payload,
                 verify=self.cert_verify(),
             )
-            _LOGGER.debug( "soap request response status %d",response.status_code)
-        except requests.exceptions.RequestException as exp:
-            _LOGGER.error( "soap request exception %s",exp)
-            self.last_exception = exp
-            return False
-        if response.status_code != 200:
-            self.last_response = response
-            return False
-        try:
-            _LOGGER.debug( "soap request response %s",response.text)
+            _LOGGER.debug("soap request response status %d", response.status_code)
+            if response.status_code != 200:
+                self.last_response = response
+                return False
+            _LOGGER.debug("soap request response %s", response.text)
             xdoc = xml.etree.ElementTree.fromstring(response.text)
             if xdoc is None:
                 return False
+            return xdoc
+        except requests.exceptions.RequestException as exp:
+            _LOGGER.error("soap request exception %s", exp)
+            self.last_exception = exp
         except xml.etree.ElementTree.ParseError as exp:
-            _LOGGER.error( "soap request xml parse error %s",exp)
+            _LOGGER.error("soap request xml parse error %s", exp)
             self.last_exception = exp
             self.last_response = response
-            return False
-        return xdoc
+        return False

ihcsdk/ihccontroller.py

@@ -2,17 +2,18 @@
 Wraps the ihcclient in a more user friendly interface to handle lost connection
 Notify thread to handle change notifications
 """
+
 # pylint: disable=invalid-name, bare-except, too-many-instance-attributes
 from datetime import datetime, timedelta
 import logging
 import requests
-import sys
 import threading
 import time
 from ihcsdk.ihcclient import IHCSoapClient, IHCSTATE_READY
 
 _LOGGER = logging.getLogger(__name__)
 
+
 class IHCController:
     """
     Implements the notification thread and
@@ -49,17 +50,17 @@ class IHCController:
                 return False
             return True
         except requests.exceptions.RequestException as exp:
-            _LOGGER.warning( "is_ihc_controller %s",exp)
+            _LOGGER.warning("is_ihc_controller %s", exp)
             return False
 
     def authenticate(self) -> bool:
         """Authenticate and enable the registered notifications"""
         with IHCController._mutex:
-            _LOGGER.debug( "Authenticating login on ihc controller")
+            _LOGGER.debug("Authenticating login on ihc controller")
             if not self.client.authenticate(self._username, self._password):
-                _LOGGER.debug( "Authentication failed")
+                _LOGGER.debug("Authentication failed")
                 return False
-            _LOGGER.debug( "Authentication was successful")
+            _LOGGER.debug("Authentication was successful")
             if self._ihcevents:
                 self.client.enable_runtime_notifications(self._ihcevents.keys())
             return True
@@ -131,7 +132,7 @@ class IHCController:
         self.re_authenticate()
         return self.client.set_runtime_value_time(ihcid, hours, minutes, seconds)
 
-    def get_project(self) -> str:
+    def get_project(self, insegments: bool = True) -> str:
         """Get the ihc project and make sure controller is ready before"""
         with IHCController._mutex:
             if self._project is None:
@@ -139,7 +140,10 @@ class IHCController:
                     ready = self.client.wait_for_state_change(IHCSTATE_READY, 10)
                     if ready != IHCSTATE_READY:
                         return None
-                self._project = self.client.get_project_in_segments()
+                if insegments:
+                    self._project = self.client.get_project_in_segments()
+                else:
+                    self._project = self.client.get_project()
         return self._project
 
     def add_notify_event(self, resourceid: int, callback, delayed=False):
@@ -165,7 +169,7 @@ class IHCController:
 
     def _notify_fn(self):
         """The notify thread function."""
-        _LOGGER.debug( "Starting notify thread")
+        _LOGGER.debug("Starting notify thread")
         while self._notifyrunning:
             try:
                 with IHCController._mutex:
@@ -178,7 +182,7 @@ class IHCController:
                 if changes is False:
                     self.re_authenticate(True)
                     continue
-                for (ihcid, value) in changes:
+                for ihcid, value in changes:
                     if ihcid in self._ihcevents:
                         for callback in self._ihcevents[ihcid]:
                             if (
@@ -188,7 +192,7 @@ class IHCController:
                                 callback(ihcid, value)
                             self._ihcvalues[ihcid] = value
             except Exception as exp:
-                _LOGGER.error( "Exception in notify thread %s",exp)
+                _LOGGER.error("Exception in notify thread %s", exp)
                 self.re_authenticate(True)
 
     def re_authenticate(self, notify: bool = False) -> bool:
@@ -200,10 +204,12 @@ class IHCController:
         """
         timeout = datetime.now() + timedelta(seconds=self.reauthenticatetimeout)
         while True:
-            _LOGGER.debug( "Reauthenticating login on ihc controller")
+            _LOGGER.debug("Reauthenticating login on ihc controller")
             if self.authenticate():
                 return True
-            _LOGGER.debug( "Authenticate failed - Reauthenticating login on ihc controller in 10 sec")
+            _LOGGER.debug(
+                "Authenticate failed - Reauthenticating login on ihc controller in 10 sec"
+            )
 
             # if called from the notify and notify a cancled we do not want to retry
             if notify:

ihcsdk/ihcsslconnection.py

@@ -1,4 +1,5 @@
 """Implements soap reqeust using the "requests" module"""
+
 # pylint: disable=too-few-public-methods
 import os
 import requests
@@ -6,7 +7,6 @@ import requests
 from cryptography.x509 import load_pem_x509_certificate
 from cryptography.hazmat.backends import default_backend
 from cryptography.hazmat.primitives import hashes
-from requests.adapters import HTTPAdapter
 from requests.packages.urllib3.util.ssl_ import create_urllib3_context
 
 from ihcsdk.ihcconnection import IHCConnection
@@ -19,7 +19,10 @@ class IHCSSLConnection(IHCConnection):
         """Initialize the IHCSSLConnection with a url for the controller"""
         super(IHCSSLConnection, self).__init__(url)
         self.cert_file = os.path.dirname(__file__) + "/certs/ihc3.crt"
-        self.session.mount("https://", CertAdapter(self.get_fingerprint_from_cert()))
+        self.session.mount(
+            "https://",
+            CertAdapter(self.get_fingerprint_from_cert(), max_retries=self.retries),
+        )
 
     def get_fingerprint_from_cert(self):
         """Get the fingerprint from the certificate"""

{ihcsdk-2.8.6.dist-info → ihcsdk-2.8.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ihcsdk
-Version: 2.8.6
+Version: 2.8.8
 Summary: IHC Python SDK
 Home-page: https://github.com/dingusdk/PythonIhcSdk
 Author: Jens Nielsen

ihcsdk-2.8.8.dist-info/RECORD

@@ -0,0 +1,12 @@
+ihcsdk/__init__.py,sha256=ocAoa28ZKxGgMlDEHWEsd7n00OtGB0R9N7XQfRlih9Q,28
+ihcsdk/ihcclient.py,sha256=LzcO0ZfIqfdQxF3TzoIfo2jVBU2u3QoZeZA4Fj3psqc,24302
+ihcsdk/ihcconnection.py,sha256=qCFhU4cAWYnqgiXWF-xjUZj1TMBZ83caDj8jEE1qaoc,2889
+ihcsdk/ihccontroller.py,sha256=9D97RX8DrFMLMxDBcIrhoYY-QEeKNjbVv_PiRW0wNyU,9180
+ihcsdk/ihcsslconnection.py,sha256=q7gDchCN2_SXItp2T3dMvlXmHC7zVO5M0bqGnepiKiU,2079
+ihcsdk/certs/ihc.crt,sha256=VYY_DiHrctlXBTNXGdJ2FN4TYuVnwnpVZ1i8t2_0cec,1002
+ihcsdk/certs/ihc3.crt,sha256=Ka2L8zQ06A76W6fZc0ckScdrj1Cn-mhgqdhc61-cCrk,1398
+ihcsdk-2.8.8.dist-info/METADATA,sha256=I2qpZJjWGY0Yad46vDMjNBljsRURFsopM0Ep8vgrn24,339
+ihcsdk-2.8.8.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+ihcsdk-2.8.8.dist-info/license.txt,sha256=jOtLnuWt7d5Hsx6XXB2QxzrSe2sWWh3NgMfFRetluQM,35147
+ihcsdk-2.8.8.dist-info/top_level.txt,sha256=QgKE7TWblC-uXe5-7MVO5JtzvrPiMoVmGgKKsVR43hU,7
+ihcsdk-2.8.8.dist-info/RECORD,,

ihcsdk-2.8.6.dist-info/RECORD

@@ -1,12 +0,0 @@
-ihcsdk/__init__.py,sha256=ocAoa28ZKxGgMlDEHWEsd7n00OtGB0R9N7XQfRlih9Q,28
-ihcsdk/ihcclient.py,sha256=VY46_PS0jMHVilJ_ViGJ_r9G5fk3--Xujf1qOrzlmx4,24118
-ihcsdk/ihcconnection.py,sha256=qnOEEsgKulIUGRS223o9YSy9qmEVR1D6jNt2XxGFGho,2577
-ihcsdk/ihccontroller.py,sha256=eYmeNGR29y5eJfU3GpRSfwZvsPMqPDjjYIYGwmtq9cE,9017
-ihcsdk/ihcsslconnection.py,sha256=4IFVg1bpdJ25yN76tnFLndvL5Rl9-qbXrbENUjyTfzw,2056
-ihcsdk/certs/ihc.crt,sha256=VYY_DiHrctlXBTNXGdJ2FN4TYuVnwnpVZ1i8t2_0cec,1002
-ihcsdk/certs/ihc3.crt,sha256=Ka2L8zQ06A76W6fZc0ckScdrj1Cn-mhgqdhc61-cCrk,1398
-ihcsdk-2.8.6.dist-info/METADATA,sha256=f9m3QS2eyYX9icV_tw6l9-Vxwmcnj5tSwCUuGmlRQcg,339
-ihcsdk-2.8.6.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-ihcsdk-2.8.6.dist-info/license.txt,sha256=jOtLnuWt7d5Hsx6XXB2QxzrSe2sWWh3NgMfFRetluQM,35147
-ihcsdk-2.8.6.dist-info/top_level.txt,sha256=QgKE7TWblC-uXe5-7MVO5JtzvrPiMoVmGgKKsVR43hU,7
-ihcsdk-2.8.6.dist-info/RECORD,,