qe-api-client 2.4.0__tar.gz → 2.6.0__tar.gz

{qe_api_client-2.4.0 → qe_api_client-2.6.0}/PKG-INFO

@@ -1,7 +1,7 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: qe-api-client
-Version: 2.4.0
-Summary: Python wrapper around Qlik Engine JSON API
+Version: 2.6.0
+Summary: Python client for the Qlik Engine JSON API
 Home-page: https://github.com/lr-bicc/qe-api-client
 Author: Rumen Vasilev
 Author-email: R.Vasilev@LRWorld.com
@@ -19,13 +19,14 @@ Dynamic: classifier
 Dynamic: description
 Dynamic: description-content-type
 Dynamic: home-page
+Dynamic: license-file
 Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary
 
 # Qlik Engine API Client
 
-Python wrapper around [Qlik Engine JSON API](https://help.qlik.com/en-US/sense-developer/February2024/Subsystems/EngineAPI/Content/Sense_EngineAPI/introducing-engine-API.htm)
+Python client for the [Qlik Engine JSON API](https://help.qlik.com/en-US/sense-developer/November2024/Subsystems/EngineAPI/Content/Sense_EngineAPI/introducing-engine-API.htm)
 
 Forked from [jhettler/pyqlikengine](https://github.com/jhettler/pyqlikengine)
 

{qe_api_client-2.4.0 → qe_api_client-2.6.0}/README.md

@@ -1,6 +1,6 @@
 # Qlik Engine API Client
 
-Python wrapper around [Qlik Engine JSON API](https://help.qlik.com/en-US/sense-developer/February2024/Subsystems/EngineAPI/Content/Sense_EngineAPI/introducing-engine-API.htm)
+Python client for the [Qlik Engine JSON API](https://help.qlik.com/en-US/sense-developer/November2024/Subsystems/EngineAPI/Content/Sense_EngineAPI/introducing-engine-API.htm)
 
 Forked from [jhettler/pyqlikengine](https://github.com/jhettler/pyqlikengine)
 

{qe_api_client-2.4.0 → qe_api_client-2.6.0}/qe_api_client/api_classes/engine_app_api.py

@@ -115,18 +115,18 @@ class EngineAppApi:
         except KeyError:
             return response['error']
 
-    def get_object(self, doc_handle, object_id):
+    def get_object(self, app_handle, object_id):
         """
         Retrieves a specific object from the app identified by the document handle.
 
         Parameters:
-            doc_handle (int): The handle identifying the app document.
+            app_handle (int): The handle identifying the app document.
             object_id (str): The ID of the object to retrieve.
 
         Returns:
             dict: The retrieved object (qReturn). In case of an error, returns the error information.
         """
-        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetObject",
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": app_handle, "method": "GetObject",
                           "params": {"qId": object_id}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
@@ -556,16 +556,6 @@ class EngineAppApi:
         except KeyError:
             return response['error']
 
-    # GetDimension: Get the handle of a dimension by using the GetDimension method.  # NOQA
-    # Parameter: dimension id
-    def get_dimension(self, doc_handle, dim_id):
-        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetDimension",
-                          "params": [dim_id]})
-        response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
-        try:
-            return response['result']['qReturn']
-        except KeyError:
-            return response['error']
 
     # GetEmptyScript: Creates a script that contains one section. This section contains Set statements that give  # NOQA
     # localized information from the regional settings of the computer.

{qe_api_client-2.4.0 → qe_api_client-2.6.0}/qe_api_client/api_classes/engine_generic_dimension_api.py

@@ -18,18 +18,18 @@ class EngineGenericDimensionApi:
         """
         self.engine_socket = socket
 
-    def get_dimension(self, handle, dimension_id):
+    def get_dimension(self, app_handle: int, dimension_id: str):
         """
         Retrieves the definition of a specific dimension from the Qlik Sense engine.
 
         Parameters:
-            handle (int): The handle identifying the dimension object.
+            app_handle (int): The handle identifying the application.
             dimension_id (str): The unique identifier (qId) of the dimension to retrieve.
 
         Returns:
             dict: The definition of the requested dimension (qReturn). In case of an error, returns the error information.
         """
-        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": handle, "method": "GetDimension",
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": app_handle, "method": "GetDimension",
                           "params": {"qId": dimension_id}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:

{qe_api_client-2.4.0 → qe_api_client-2.6.0}/qe_api_client/api_classes/engine_generic_measure_api.py

@@ -18,18 +18,18 @@ class EngineGenericMeasureApi:
         """
         self.engine_socket = socket
 
-    def get_measure(self, handle, measure_id):
+    def get_measure(self, app_handle: int, measure_id: str):
         """
         Retrieves the definition of a specific measure from the Qlik Sense engine.
 
         Parameters:
-            handle (int): The handle identifying the measure object.
+            app_handle (int): The handle identifying the application.
             measure_id (str): The unique identifier (qId) of the measure to retrieve.
 
         Returns:
             dict: The definition of the requested measure (qReturn). In case of an error, returns the error information.
         """
-        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": handle, "method": "GetMeasure", "params": {"qId": measure_id}})
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": app_handle, "method": "GetMeasure", "params": {"qId": measure_id}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
             return response["result"]["qReturn"]

{qe_api_client-2.4.0 → qe_api_client-2.6.0}/qe_api_client/api_classes/engine_generic_object_api.py

@@ -24,24 +24,54 @@ class EngineGenericObjectApi:
             socket (object): The socket connection to the Qlik Sense engine.
         """
         self.engine_socket = socket
-    def create_child(self, handle, params):
+
+    def apply_patches(self, handle: int, patches: list, soft_patch: bool = False):
         """
-        Retrieves the layout structure of a specific generic object.
+        Applies a patch to the properties of an object. Allows an update to some of the properties. It is possible to
+        apply a patch to the properties of a generic object, that is not persistent. Such a patch is called a soft patch.
+        In that case, the result of the operation on the properties (add, remove or delete) is not shown when doing
+        GetProperties, and only a GetLayout call shows the result of the operation. Properties that are not persistent
+        are called soft properties. Once the engine session is over, soft properties are cleared. It should not be
+        possible to patch "/qInfo/qId", and it will be forbidden in the near future.
 
         Parameters:
             handle (int): The handle identifying the generic object.
-            params (str): The parameters of the generic object.
+            patches (list): List of patches.
+            soft_patch (bool, optional): If set to true, it means that the properties to be applied are not persistent.
+            The patch is a soft patch. The default value is false.
 
         Returns:
-            dict: The layout structure of the generic object (qLayout). In case of an error, returns the error information.
+            dict: Operation succeeded.
         """
-        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": handle, "method": "CreateChild", "params": [params]})
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": handle, "method": "ApplyPatches",
+                          "params": {"qPatches": patches, "qSoftPatch": soft_patch}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
             return response["result"]
         except KeyError:
             return response["error"]
 
+    def create_child(self, handle: int, prop: dict, prop_for_this: dict = None):
+        """
+        Creates a generic object that is a child of another generic object.
+
+        Parameters:
+            handle (int): The handle identifying the generic object.
+            prop (dict): Information about the child. It is possible to create a child that is linked to another object.
+            prop_for_this (dict, optional): Identifier of the parent's object. Should be set to update the properties of
+            the parent's object at the same time the child is created.
+
+        Returns:
+            dict: The layout structure of the generic object (qLayout). In case of an error, returns the error information.
+        """
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": handle, "method": "CreateChild",
+                          "params": {"qProp": prop, "qPropForThis": prop_for_this}})
+        response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
+        try:
+            return response["result"]["qReturn"]
+        except KeyError:
+            return response["error"]
+
     def get_layout(self, handle):
         """
         Retrieves the layout structure of a specific generic object.