qe-api-client 1.2.0__py3-none-any.whl → 2.1.0__py3-none-any.whl

qe_api_client/api_classes/engine_field_api.py

@@ -0,0 +1,127 @@
+import json
+
+
+class EngineFieldApi:
+    """
+    A client for interacting with the Qlik Engine JSON API for field operations.
+
+    Args:
+        socket: An object representing the engine socket connection used to communicate with the Qlik Engine.
+    """
+
+    def __init__(self, socket):
+        """
+        Initializes the EngineFieldApi with the provided socket.
+
+        Args:
+            socket: An engine socket object used to send and receive messages from the Qlik Engine.
+        """
+        self.engine_socket = socket
+
+    def select(self, fld_handle, value):
+        """
+        Selects a specific value in a field.
+
+        Args:
+            fld_handle (int): The handle of the field.
+            value (str): The value to select.
+
+        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]})
+        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):
+        """
+        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.
+
+        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]})
+        response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
+        try:
+            return response
+        except KeyError:
+            return response["error"]
+
+    def select_excluded(self, fld_handle):
+        """
+        Selects all excluded values in a field.
+
+        Args:
+            fld_handle (int): The handle of the field.
+
+        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": "SelectExcluded", "params": []})
+        response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
+        try:
+            return response["result"]
+        except KeyError:
+            return response["error"]
+
+    def select_possible(self, fld_handle):
+        """
+        Selects all possible values in a field.
+
+        Args:
+            fld_handle (int): The handle of the field.
+
+        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": "SelectPossible", "params": []})
+        response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
+        try:
+            return response["result"]
+        except KeyError:
+            return response["error"]
+
+    def clear(self, fld_handle):
+        """
+        Clears the selection in a field.
+
+        Args:
+            fld_handle (int): The handle of the field.
+
+        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": []})
+        response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
+        try:
+            return response["result"]
+        except KeyError:
+            return response["error"]
+
+    def get_cardinal(self, fld_handle):
+        """
+        Gets the number of distinct values in a field.
+
+        Args:
+            fld_handle (int): The handle of the field.
+
+        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": []})
+        response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
+        try:
+            return response["result"]
+        except KeyError:
+            return response["error"]

qe_api_client/api_classes/engine_generic_dimension_api.py

@@ -0,0 +1,38 @@
+import json
+
+
+class EngineGenericDimensionApi:
+    """
+    API class for interacting with Qlik Sense engine's generic dimension objects.
+
+    Methods:
+        get_dimension(handle, dimension_id): Retrieves the definition of a specific dimension.
+    """
+
+    def __init__(self, socket):
+        """
+        Initializes the EngineGenericDimensionApi with a given socket connection.
+
+        Parameters:
+            socket (object): The socket connection to the Qlik Sense engine.
+        """
+        self.engine_socket = socket
+
+    def get_dimension(self, handle, dimension_id):
+        """
+        Retrieves the definition of a specific dimension from the Qlik Sense engine.
+
+        Parameters:
+            handle (int): The handle identifying the dimension object.
+            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",
+                          "params": {"qId": dimension_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/api_classes/engine_generic_measure_api.py

@@ -0,0 +1,37 @@
+import json
+
+
+class EngineGenericMeasureApi:
+    """
+    API class for interacting with Qlik Sense engine's generic measure objects.
+
+    Methods:
+        get_measure(handle, measure_id): Retrieves the definition of a specific measure.
+    """
+
+    def __init__(self, socket):
+        """
+        Initializes the EngineGenericMeasureApi with a given socket connection.
+
+        Parameters:
+            socket (object): The socket connection to the Qlik Sense engine.
+        """
+        self.engine_socket = socket
+
+    def get_measure(self, handle, measure_id):
+        """
+        Retrieves the definition of a specific measure from the Qlik Sense engine.
+
+        Parameters:
+            handle (int): The handle identifying the measure object.
+            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}})
+        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/api_classes/engine_generic_object_api.py

@@ -0,0 +1,180 @@
+import json
+
+
+class EngineGenericObjectApi:
+    """
+    API class for interacting with Qlik Sense engine's generic objects, such as hypercubes, lists, and other
+    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.
+        get_hypercube_data(handle, path, pages): Retrieves the data from a hypercube.
+        get_hypercube_pivot_data(handle, path, pages): Retrieves the pivot data from a hypercube.
+        get_list_object_data(handle, path, pages): Retrieves the data from a list object.
+    """
+
+    def __init__(self, socket):
+        """
+        Initializes the EngineGenericObjectApi with a given socket connection.
+
+        Parameters:
+            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):
+        """
+        Retrieves the layout structure of a specific generic object.
+
+        Parameters:
+            handle (int): The handle identifying 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": "GetLayout", "params": []})
+        response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
+        try:
+            return response["result"]["qLayout"]
+        except KeyError:
+            return response["error"]
+
+    def get_full_property_tree(self, handle):
+        """
+        Retrieves the full property tree of a specific generic object.
+
+        Parameters:
+            handle (int): The handle identifying the generic object.
+
+        Returns:
+            dict: The full property tree of the generic object (qPropEntry). In case of an error, returns the error information.
+        """
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": handle, "method": "GetFullPropertyTree", "params": []})
+        response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
+        try:
+            return response["result"]['qPropEntry']
+        except KeyError:
+            return response["error"]
+
+    def get_effective_properties(self, handle):
+        """
+        Retrieves the effective properties of a specific generic object.
+
+        Parameters:
+            handle (int): The handle identifying the generic object.
+
+        Returns:
+            dict: The effective properties of the generic object (qProp). In case of an error, returns the error information.
+        """
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": handle, "method": "GetEffectiveProperties",
+                          "params": {}})
+        response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
+        try:
+            return response["result"]['qProp']
+        except KeyError:
+            return response["error"]
+
+    def get_hypercube_data(self, handle, path="/qHyperCubeDef", pages={}):
+        """
+        Retrieves the data from a specific hypercube in a generic object.
+
+        Parameters:
+            handle (int): The handle identifying the generic object containing the hypercube.
+            path (str): The path to the hypercube definition within the object. Default is "/qHyperCubeDef".
+            pages (list): A list of pages to retrieve from the hypercube data.
+
+        Returns:
+            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": {"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={}):
+        """
+        Retrieves the pivot data from a specific hypercube in a generic object.
+
+        Parameters:
+            handle (int): The handle identifying the generic object containing the hypercube.
+            path (str): The path to the hypercube definition within the object. Default is "/qHyperCubeDef".
+            pages (list): A list of pages to retrieve from the hypercube pivot data.
+
+        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": {"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):
+        """
+        Retrieves the values of a stacked pivot table. It is possible to retrieve specific pages of data.
+
+        Parameters:
+            handle (int): The handle identifying the generic object containing the hypercube.
+            path (str): The path to the hypercube definition within the object. Default is "/qHyperCubeDef".
+            pages (list): A list of pages to retrieve from the hypercube pivot data.
+            max_no_cells (int): Maximum number of cells at outer level. The default value is 10 000.
+
+
+        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": "GetHyperCubeStackData",
+                          "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"]
+        except KeyError:
+            return response["error"]
+
+    def get_list_object_data(self, handle, path="/qListObjectDef", pages=[]):
+        """
+        Retrieves the data from a specific list object in a generic object.
+
+        Parameters:
+            handle (int): The handle identifying the generic object containing the list object.
+            path (str): The path to the list object definition within the object. Default is "/qListObjectDef".
+            pages (list): A list of pages to retrieve from the list object data.
+
+        Returns:
+            dict: The data from the list object. In case of an error, returns the error information.
+        """
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": handle,
+                          "method": "GetListObjectData",
+                          "params": [path, pages]})
+        response = json.loads(self.engine_socket.send_call(self.engine_socket,
+                                                           msg)
+                              )
+        try:
+            return response["result"]
+        except KeyError:
+            return response["error"]

qe_api_client/api_classes/engine_generic_variable_api.py

@@ -0,0 +1,56 @@
+import json
+
+
+class EngineGenericVariableApi:
+    """
+    API class for interacting with Qlik Sense engine's generic variable object.
+
+    Methods:
+        set_string_value(handle, str_val): Sets the value of a string variable.
+        get_properties(handle): Retrieves the properties of a generic variable.
+    """
+
+    def __init__(self, socket):
+        """
+        Initializes the EngineGenericVariableApi with a given socket connection.
+
+        Parameters:
+            socket (object): The socket connection to the Qlik Sense engine.
+        """
+        self.engine_socket = socket
+
+    def set_string_value(self, handle, str_val):
+        """
+        Sets the value of a string variable in the Qlik Sense engine.
+
+        Parameters:
+            handle (int): The handle identifying the variable.
+            str_val (str): The string value to set for the variable.
+
+        Returns:
+            dict: The result of the set operation. In case of an error, returns the error information.
+        """
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": handle, "method": "SetStringValue",
+                          "params": {"qVal": str_val}})
+        response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
+        try:
+            return response["result"]
+        except KeyError:
+            return response["error"]
+
+    def get_properties(self, handle):
+        """
+        Retrieves the properties of a generic variable from the Qlik Sense engine.
+
+        Parameters:
+            handle (int): The handle identifying the variable.
+
+        Returns:
+            dict: The properties of the generic variable. In case of an error, returns the error information.
+        """
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": handle, "method": "GetProperties", "params": {}})
+        response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
+        try:
+            return response["result"]
+        except KeyError:
+            return response["error"]