qe-api-client 2.0.0__tar.gz → 2.2.0__tar.gz

{qe_api_client-2.0.0 → qe_api_client-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qe-api-client
-Version: 2.0.0
+Version: 2.2.0
 Summary: Python wrapper around Qlik Engine JSON API
 Home-page: https://github.com/lr-bicc/qe-api-client
 Author: Rumen Vasilev

{qe_api_client-2.0.0 → qe_api_client-2.2.0}/qe_api_client/api_classes/engine_app_api.py

@@ -141,10 +141,10 @@ class EngineAppApi:
         Parameters:
             doc_handle (int): The handle identifying the app document.
             field_name (str): The name of the field to retrieve.
-            state_name (str): The name of the state. Default is an empty string, indicating the default state.
+            state_name (str): The name of the alternate state. Default state is current selections.
 
         Returns:
-            dict: The retrieved field (qReturn). In case of an error, returns the error information.
+            dict: Object interface.
         """
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetField",
                           "params": {"qFieldName": field_name, "qStateName": state_name}})
@@ -154,22 +154,19 @@ class EngineAppApi:
         except KeyError:
             return response['error']
 
-    def create_object(self, doc_handle, q_id="LB01", q_type="ListObject", struct_name="qListObjectDef", ob_struct={}):
+    def create_object(self, doc_handle, prop):
         """
         Creates a new object in the app identified by the document handle.
 
         Parameters:
             doc_handle (int): The handle identifying the app document.
-            q_id (str): The ID of the new object. Default is "LB01".
-            q_type (str): The type of the new object. Default is "ListObject".
-            struct_name (str): The name of the structure defining the object. Default is "qListObjectDef".
-            ob_struct (dict): The structure defining the object.
+            prop (dict): Information about the object.
 
         Returns:
             dict: The created object (qReturn). In case of an error, returns the error information.
         """
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "method": "CreateObject", "handle": doc_handle,
-                          "params": [{"qInfo": {"qId": q_id, "qType": q_type}, struct_name: ob_struct}]})
+                          "params": {"qProp": prop}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
             return response['result']['qReturn']
@@ -223,8 +220,16 @@ class EngineAppApi:
             return response['error']
 
     def clear_all(self, doc_handle, locked_also=False, alt_state=""):
+        """
+        Clear selections in fields for current state. Locked fields are not cleared by default.
+
+        Parameters:
+            doc_handle (int): The handle identifying the app document.
+            locked_also (bool): When true, clears the selection for locked fields.
+            alt_state (str): Alternate state name. When set, applies to alternate state instead of current.
+        """
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "ClearAll",
-                          "params": [locked_also, alt_state]})
+                          "params": {"qLockedAlso": locked_also, "qStateName": alt_state}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
             return response['result']
@@ -250,45 +255,24 @@ class EngineAppApi:
     # can contain the same dimension.
     # Parameters:
     # qProp (MANDATORY: send dim_id, dim_title, dim_grouping, dim_field, dim_label, meta_def (optional)  # NOQA
-    def create_master_dim(self, doc_handle, dim_id, dim_title,
-                          dim_grouping="N", dim_field='', dim_label='',
-                          meta_def=""):
+    def create_dimension(self, doc_handle, prop):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "CreateDimension",
-                          "params": [{
-                                "qInfo": {
-                                    "qId": dim_id,
-                                    "qType": "Dimension"
-                                },
-                                "qDim": {
-                                    "title": dim_title,
-                                    "qGrouping": dim_grouping,
-                                    "qFieldDefs": [
-                                        dim_field
-                                    ],
-                                    "qFieldLabels": [
-                                        dim_label
-                                    ]
-                                },
-                                "qMetaDef": {
-                                    "title": meta_def
-                                }
-                            }]
-                          })
+                          "params": {"qProp": prop}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
-            return response['result']
+            return response["result"]["qReturn"]
         except KeyError:
             return response['error']
 
     # DestroyDimension method: Removes a dimension
-    def destroy_dim(self, doc_handle, dim_id):
+    def destroy_dimension(self, doc_handle, dim_id):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "DestroyDimension",
-                          "params": [{dim_id}]})
+                          "params": {"qId": dim_id}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
-            return response['result']
+            return response["result"]["qSuccess"]
         except KeyError:
-            return response['error']
+            return response["error"]
 
     # DestroyMeasure method: Removes a measure
     def destroy_measure(self, doc_handle, measure_id):
@@ -347,25 +331,12 @@ class EngineAppApi:
     # can contain the same dimension.
     # Parameters:
     # qProp (MANDATORY: send dim_id, dim_title, dim_grouping, dim_field, dim_label, meta_def (optional)  # NOQA
-    def create_master_measure(self, doc_handle, measure_id, measure_title, measure_expr, meta_def=""):
-        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle,
-                          "method": "CreateMeasure", "params": [{
-                                "qInfo": {
-                                    "qId": measure_id,
-                                    "qType": "Measure"
-                                },
-                                "qMeasure": {
-                                    "qLabel": measure_title,
-                                    "qDef": measure_expr
-                                },
-                                "qMetaDef": {
-                                    "title": measure_title
-                                }
-                            }]
-                          })
+    def create_measure(self, doc_handle, prop):
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "CreateMeasure",
+                          "params": {"qProp": prop}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
-            return response['result']
+            return response["result"]["qReturn"]
         except KeyError:
             return response['error']
 
@@ -702,9 +673,9 @@ class EngineAppApi:
         except KeyError:
             return response['error']
 
-    def create_session_object(self, doc_handle, param):
+    def create_session_object(self, doc_handle, prop):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "CreateSessionObject",
-                          "params": [param]})
+                          "params": {"qProp": prop}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
             return response['result']['qReturn']

{qe_api_client-2.0.0 → qe_api_client-2.2.0}/qe_api_client/api_classes/engine_field_api.py

@@ -18,77 +18,87 @@ class EngineFieldApi:
         """
         self.engine_socket = socket
 
-    def select(self, fld_handle, value):
+    def select(self, fld_handle, value, soft_lock = False, excluded_values_mode = 0):
         """
-        Selects a specific value in a field.
+        Selects field values matching a search string.
 
         Args:
             fld_handle (int): The handle of the field.
-            value (str): The value to select.
+            value (str): String to search for. Can contain wild cards or numeric search criteria.
+            soft_lock (bool): Set to true to ignore locks; in that case, locked fields can be selected.
+            excluded_values_mode (int): Include excluded values in search.
 
         Returns:
             dict: The response from the engine, containing the result or an error message.
         """
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": fld_handle, "method": "Select",
-                          "params": [value, False, 0]})
+                          "params": {"qMatch": value, "qSoftLock": soft_lock,
+                                     "qExcludedValuesMode": excluded_values_mode}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
             return response
         except KeyError:
             return response["error"]
 
-    def select_values(self, fld_handle, values=None):
+    def select_values(self, fld_handle, values, toggle_mode = False, soft_lock = False):
         """
         Selects multiple values in a field.
 
         Args:
             fld_handle (int): The handle of the field.
-            values (list, optional): A list of values to select. Defaults to an empty list.
+            values (list): A list of field values to select. Mandatory field.
+            toggle_mode (bool): The default value is false.
+            soft_lock (bool): Set to true to ignore locks; in that case, locked fields can be selected.
+            The default value is false.
 
         Returns:
             dict: The response from the engine, containing the result or an error message.
         """
-        if values is None:
-            values = []
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": fld_handle, "method": "SelectValues",
-                          "params": [values, False, False]})
+                          "params": {"qFieldValues": values, "qToggleMode": toggle_mode, "qSoftLock": soft_lock}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
-            return response
+            return response["result"]["qReturn"]
         except KeyError:
             return response["error"]
 
-    def select_excluded(self, fld_handle):
+    def select_excluded(self, fld_handle, soft_lock=False):
         """
-        Selects all excluded values in a field.
+        Inverts the current selections.
 
         Args:
             fld_handle (int): The handle of the field.
+            soft_lock (bool): Set to true to ignore locks; in that case, locked fields can be selected.
+            The default value is false.
 
         Returns:
-            dict: The response from the engine, containing the result or an error message.
+            bool: true/false. The operation is successful if qReturn is set to true.
         """
-        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": fld_handle, "method": "SelectExcluded", "params": []})
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": fld_handle, "method": "SelectExcluded",
+                          "params": {"qSoftLock": soft_lock}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
-            return response["result"]
+            return response["result"]["qReturn"]
         except KeyError:
             return response["error"]
 
-    def select_possible(self, fld_handle):
+    def select_possible(self, fld_handle, soft_lock=False):
         """
         Selects all possible values in a field.
 
         Args:
             fld_handle (int): The handle of the field.
+            soft_lock (bool): Set to true to ignore locks; in that case, locked fields can be selected.
+            The default value is false.
 
         Returns:
-            dict: The response from the engine, containing the result or an error message.
+            bool: true/false. The operation is successful if qReturn is set to true.
         """
-        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": fld_handle, "method": "SelectPossible", "params": []})
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": fld_handle, "method": "SelectPossible",
+                          "params": {"qSoftLock": soft_lock}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
-            return response["result"]
+            return response["result"]["qReturn"]
         except KeyError:
             return response["error"]
 
@@ -102,7 +112,7 @@ class EngineFieldApi:
         Returns:
             dict: The response from the engine, containing the result or an error message.
         """
-        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": fld_handle, "method": "Clear", "params": []})
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": fld_handle, "method": "Clear", "params": {}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
             return response["result"]
@@ -119,9 +129,9 @@ class EngineFieldApi:
         Returns:
             int: The number of distinct values in the field, or an error message.
         """
-        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": fld_handle, "method": "GetCardinal", "params": []})
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": fld_handle, "method": "GetCardinal", "params": {}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
-            return response["result"]
+            return response["result"]["qReturn"]
         except KeyError:
             return response["error"]

{qe_api_client-2.0.0 → qe_api_client-2.2.0}/qe_api_client/api_classes/engine_generic_object_api.py

@@ -7,6 +7,7 @@ class EngineGenericObjectApi:
     data visualization objects.
 
     Methods:
+        create_child(handle, params): Creates a generic object that is a child of another generic object.
         get_layout(handle): Retrieves the layout structure of a generic object.
         get_full_property_tree(handle): Retrieves the full property tree of a generic object.
         get_effective_properties(handle): Retrieves the effective properties of a generic object.
@@ -23,6 +24,23 @@ class EngineGenericObjectApi:
             socket (object): The socket connection to the Qlik Sense engine.
         """
         self.engine_socket = socket
+    def create_child(self, handle, params):
+        """
+        Retrieves the layout structure of a specific generic object.
+
+        Parameters:
+            handle (int): The handle identifying the generic object.
+            params (str): The parameters of the generic object.
+
+        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": [params]})
+        response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
+        try:
+            return response["result"]
+        except KeyError:
+            return response["error"]
 
     def get_layout(self, handle):
         """
@@ -76,7 +94,7 @@ class EngineGenericObjectApi:
         except KeyError:
             return response["error"]
 
-    def get_hypercube_data(self, handle, path="/qHyperCubeDef", pages=[]):
+    def get_hypercube_data(self, handle, path="/qHyperCubeDef", pages={}):
         """
         Retrieves the data from a specific hypercube in a generic object.
 
@@ -89,14 +107,14 @@ class EngineGenericObjectApi:
             dict: The data from the hypercube. In case of an error, returns the error information.
         """
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": handle, "method": "GetHyperCubeData",
-                          "params": [path, pages]})
+                          "params": {"qPath": path, "qPages": [pages]}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
             return response["result"]
         except KeyError:
             return response["error"]
 
-    def get_hypercube_pivot_data(self, handle, path="/qHyperCubeDef", pages=[]):
+    def get_hypercube_pivot_data(self, handle, path="/qHyperCubeDef", pages={}):
         """
         Retrieves the pivot data from a specific hypercube in a generic object.
 
@@ -108,16 +126,15 @@ class EngineGenericObjectApi:
         Returns:
             dict: The pivot data from the hypercube. In case of an error, returns the error information.
         """
-        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": handle,
-                          "method": "GetHyperCubePivotData",
-                          "params": [path, pages]})
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": handle, "method": "GetHyperCubePivotData",
+                          "params": {"qPath": path, "qPages": [pages]}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
             return response["result"]
         except KeyError:
             return response["error"]
 
-    def get_hypercube_stack_data(self, handle, path="/qHyperCubeDef", pages=[], max_no_cells=10000):
+    def get_hypercube_stack_data(self, handle, path="/qHyperCubeDef", pages={}, max_no_cells=10000):
         """
         Retrieves the values of a stacked pivot table. It is possible to retrieve specific pages of data.
 
@@ -132,7 +149,7 @@ class EngineGenericObjectApi:
             dict: The pivot data from the hypercube. In case of an error, returns the error information.
         """
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": handle, "method": "GetHyperCubeStackData",
-                          "params": [path, pages, max_no_cells]})
+                          "params": {"qPath": path, "qPages": [pages], "qMaxNbrCells": max_no_cells}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
             return response["result"]

{qe_api_client-2.0.0 → qe_api_client-2.2.0}/qe_api_client/api_classes/engine_global_api.py

@@ -85,7 +85,8 @@ class EngineGlobalApi:
         Returns:
         dict: Information about the deletion result.
         """
-        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": -1, "method": "DeleteApp", "params": [app_name]})
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": -1, "method": "DeleteApp",
+                          "params": {"qAppId": app_name}})
         response = json.loads(
             self.engine_socket.send_call(self.engine_socket, msg))
         try: