qe-api-client 2.3.0__tar.gz → 2.5.0__tar.gz

{qe_api_client-2.3.0 → qe_api_client-2.5.0}/PKG-INFO

@@ -1,7 +1,7 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: qe-api-client
-Version: 2.3.0
-Summary: Python wrapper around Qlik Engine JSON API
+Version: 2.5.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
@@ -12,6 +12,16 @@ Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: websocket-client>=0.47.0
+Requires-Dist: pandas>=2.2.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # Qlik Engine API Client
 

{qe_api_client-2.3.0 → qe_api_client-2.5.0}/qe_api_client/api_classes/engine_app_api.py

@@ -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.
@@ -708,5 +698,24 @@ class EngineAppApi:
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
             return response['result']
+        except KeyError:
+            return response['error']
+
+    def get_variable_by_id(self, doc_handle, variable_id):
+        """
+        Gets the handle of a variable.
+
+        Parameters:
+            doc_handle (int): The handle identifying the document.
+            variable_id (str): The id of the variable.
+
+        Returns:
+            dict: The handle of the generic variable.
+        """
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetVariableById",
+                          "params": {"qId": variable_id}})
+        response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
+        try:
+            return response['result']['qReturn']
         except KeyError:
             return response['error']

{qe_api_client-2.3.0 → qe_api_client-2.5.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.3.0 → qe_api_client-2.5.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"]