qe-api-client 2.2.0__py3-none-any.whl → 2.4.0__py3-none-any.whl

qe_api_client/api_classes/engine_app_api.py

@@ -79,7 +79,7 @@ class EngineAppApi:
         except KeyError:
             return response['error']
 
-    def do_reload_ex(self, doc_handle, param_list=[]):
+    def do_reload_ex(self, doc_handle, param_list={}):
         """
         Triggers an extended reload of the app identified by the document handle.
 
@@ -91,10 +91,10 @@ class EngineAppApi:
             dict: The result of the extended reload operation. In case of an error, returns the error information.
         """
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "DoReloadEx",
-                          "params": param_list})
+                          "params": {"qParams": param_list}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
-            return response['result']
+            return response["result"]["qResult"]
         except KeyError:
             return response['error']
 
@@ -435,8 +435,9 @@ class EngineAppApi:
 
     # DoSave method: Saves an app - All objects and data in the data model are saved.  # NOQA
     # Desktop only - server auto saves
-    def do_save(self, doc_handle):
-        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "DoSave", "params": []})
+    def do_save(self, doc_handle, file_name=""):
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "DoSave",
+                          "params": {"qFileName": file_name}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
             return response['result']
@@ -666,7 +667,17 @@ class EngineAppApi:
 
     # GetAllInfos method: Get the identifier and the type of any generic object in an app by using the GetAllInfos method.  # NOQA
     def get_lineage(self, doc_handle):
-        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetLineage", "params": []})
+        """
+        Gets the lineage information of the app. The lineage information includes the LOAD and STORE statements from
+        the data load script associated with this app.
+
+        Parameters:
+            doc_handle (int): The handle identifying the app document.
+
+        Returns:
+            list: Information about the lineage of the data in the app.
+        """
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetLineage", "params": {}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
             return response['result']['qLineage']
@@ -697,5 +708,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/engine.py

@@ -90,12 +90,62 @@ class QixEngine:
         return self.efa.clear(fld_handle)
 
     def create_single_master_dimension(self, app_handle, dim_title, dim_def, dim_label):
+        """
+        Creates a single master dimension.
+
+        Parameters:
+            app_handle (int): The handle of the app.
+            dim_title (str): The title of the dimension.
+            dim_def (str): The definition of the dimension.
+            dim_label (str): The label of the dimension.
+
+        Returns:
+            dict: The handle and Id of the dimension.
+        """
         nx_info = self.structs.nx_info("dimension")
         lb_dim_def = self.structs.nx_library_dimension_def("N",[dim_def],[""],dim_label)
         gen_dim_props = self.structs.generic_dimension_properties(nx_info, lb_dim_def, dim_title)
         master_dim = self.eaa.create_dimension(app_handle, gen_dim_props)
         return master_dim
 
+    def create_master_measure(self, app_handle, mes_title, mes_def, mes_label):
+        """
+        Creates a master measure.
+
+        Parameters:
+            app_handle (int): The handle of the app.
+            mes_title (str): The title of the measure.
+            mes_def (str): The definition of the measure.
+            mes_label (str): The label of the measure.
+
+        Returns:
+            dict: The handle and Id of the measure.
+        """
+        nx_info = self.structs.nx_info("measure")
+        lb_mes_def = self.structs.nx_inline_measure_def(mes_def,mes_label)
+        gen_mes_props = self.structs.generic_measure_properties(nx_info, lb_mes_def, mes_title)
+        master_mes = self.eaa.create_measure(app_handle, gen_mes_props)
+        return master_mes
+
+    def get_app_lineage_info(self, app_handle):
+        """
+        Gets the lineage information of the app. The lineage information includes the LOAD and STORE statements from
+        the data load script associated with this app.
+
+        Parameters:
+            app_handle (int): The handle of the app.
+
+        Returns:
+        DataFrame: Information about the lineage of the data in the app.
+        """
+        # Lineage-Daten aus der API holen
+        lineage_info = self.eaa.get_lineage(app_handle)
+
+        # Erstelle den DataFrame und fülle fehlende Werte mit ""
+        df_lineage_info = pd.DataFrame(lineage_info)
+        df_lineage_info = df_lineage_info[(df_lineage_info["qDiscriminator"].notna()) | (df_lineage_info["qStatement"].notna())].fillna("")
+        return df_lineage_info
+
     def disconnect(self):
         self.conn.close_qvengine_connection(self.conn)
 

qe_api_client/engine_communicator.py

@@ -22,21 +22,12 @@ class EngineCommunicator:
 
 class SecureEngineCommunicator(EngineCommunicator):
 
-    def __init__(self, url, user_directory,
-                 user_id, ca_certs, certfile,
-                 keyfile, app_id=None
-                 ):
+    def __init__(self, url, user_directory, user_id, ca_certs, certfile, keyfile, app_id=None):
         self.url = "wss://" + url + ":4747/app/" + str(app_id)
-        certs = ({"ca_certs": ca_certs,
-                  "certfile": certfile,
-                  "keyfile": keyfile,
-                  "cert_reqs": ssl.CERT_NONE,
-                  "server_side": False
-                  })
+        certs = ({"ca_certs": ca_certs, "certfile": certfile, "keyfile": keyfile, "cert_reqs": ssl.CERT_NONE,
+                  "server_side": False})
 
         ssl.match_hostname = lambda cert, hostname: True
         header = f'X-Qlik-User: UserDirectory={user_directory}; UserId={user_id}'  # NOQA
-        self.ws = create_connection(
-                self.url, sslopt=certs,
-                cookie=None, header={header})
+        self.ws = create_connection(self.url, sslopt=certs, cookie=None, header={header})
         self.session = self.ws.recv()

qe_api_client/structs.py

@@ -66,4 +66,13 @@ def num_format(type="U", n_dec=10, use_thou=0, fmt="", dec="", thou=""):
     return {"qType": type, "qnDec": n_dec, "qUseThou": use_thou, "qFmt": fmt, "qDec": dec, "qThou": thou}
 
 def generic_measure_properties(info, lb_meas_def, meas_title):
-    return {"qInfo": info, "qMeasure": lb_meas_def, "qMetaDef": {"title": meas_title}}
+    return {"qInfo": info, "qMeasure": lb_meas_def, "qMetaDef": {"title": meas_title}}
+
+def do_reload_ex_params(mode=0, partial=False, debug=False, reload_id="", skip_store=False, row_limit=0):
+    return {"qMode": mode, "qPartial": partial, "qDebug": debug, "qReloadId": reload_id, "qSkipStore": skip_store,
+            "qRowLimit": row_limit}
+
+def dimension_list_def():
+    return {"qInfo": {"qType": "DimensionList"},
+            "qDimensionListDef": {"qType": "dimension",
+            "qData": {"title": "/title", "tags": "/tags", "grouping": "/qDim/qGrouping", "info": "/qDimInfos"}}}

{qe_api_client-2.2.0.dist-info → qe_api_client-2.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: qe-api-client
-Version: 2.2.0
+Version: 2.4.0
 Summary: Python wrapper around Qlik Engine JSON API
 Home-page: https://github.com/lr-bicc/qe-api-client
 Author: Rumen Vasilev
@@ -11,7 +11,17 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: websocket-client >=0.47.0
+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
 
@@ -28,7 +38,7 @@ Forked from [jhettler/pyqlikengine](https://github.com/jhettler/pyqlikengine)
 pip install qe-api-client
 ```
 
-## Example of usage on Qlik Sense Enterprise Server
+## Connecting to Qlik Sense Enterprise Server
 You need to export the Qlik Sense certificates in PEM format from the Qlik Sense Enterprise server to a local folder in 
 order to authenticate on the server.
 
@@ -48,7 +58,7 @@ qixe = QixEngine(url=url, user_directory=user_directory, user_id=user_id, ca_cer
 print(qixe.ega.get_doc_list())
 ```
 
-## Example of usage on Qlik Sense Desktop
+## Connecting to Qlik Sense Desktop
 You need to start your Qlik Sense Desktop client on your local PC.
 
 ```python
@@ -61,5 +71,8 @@ qixe = QixEngine(url=url)
 print(qixe.ega.get_doc_list())
 ```
 
+## Examples of usage
+Please click on this [link](https://github.com/lr-bicc/qe-api-client/tree/master/examples) to find examples of usage of this client.
+
 ## API reference
 Please click on this [link](https://lr-bicc.github.io/qe-api-client) for full API reference documentation .

{qe_api_client-2.2.0.dist-info → qe_api_client-2.4.0.dist-info}/RECORD

@@ -1,18 +1,17 @@
 qe_api_client/__init__.py,sha256=bypB4CIjpHtf5Pu_NwtJajC69zqQD7qB9jo8cCX0B54,23
-qe_api_client/engine.py,sha256=zK6FxdsxiFy3-IpZ664gcsoJU9dpTdVm4NWn6zgXa6E,14944
-qe_api_client/engine_communicator.py,sha256=Va8Kz4cN6uyKLzV3JllBw08KbU4uDn8e-5pIm5Kmsfs,1291
-qe_api_client/engine_helper.py,sha256=DSZR92-pGqklzki53QufgGr9tUTKKXZyF_fHEfXokTs,2382
-qe_api_client/structs.py,sha256=9oB8-APCIkt1nNtwRpqGGMvzF42SX2ep5r4zSrLkjL4,3999
+qe_api_client/engine.py,sha256=SCTjKlhtir2kOMNDnfwd1Cz-Su6xxDk79GBUtAMgSpU,16900
+qe_api_client/engine_communicator.py,sha256=q6x7ix2Ev8yGmTTm7cf1vHcidOihKM0HjDXeJ-dZYjk,1133
+qe_api_client/structs.py,sha256=eZw-M9QBhZe_lHxjMcWU5TJVi18G43FhCMMGzjdJxAk,4502
 qe_api_client/api_classes/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-qe_api_client/api_classes/engine_app_api.py,sha256=3bQHufiKvWHOOKjX50WK7pbH-fM0Rz6WMblEgEjAn2I,36847
+qe_api_client/api_classes/engine_app_api.py,sha256=H0CF-BwSUi1ZpZo7pyQg736jsdKm5biShVcELun9jwY,38021
 qe_api_client/api_classes/engine_field_api.py,sha256=zCLIR7rmxqwIrJYK_-uHVEhMvBcEP2qofuX8ZPygqCA,5479
 qe_api_client/api_classes/engine_generic_dimension_api.py,sha256=1joTET6GWCTW-80wafrajLQuMyFwIPp0QKoILyLdP1U,1377
 qe_api_client/api_classes/engine_generic_measure_api.py,sha256=zbRYRA99LQS9SY3QVgoUABqgVDRPwBQ8o2ZbESVEsHE,1321
 qe_api_client/api_classes/engine_generic_object_api.py,sha256=nqsEtvKkt5XkUEIVUoBtNVXtmUvuifxrgTcw2fDuaOE,8218
 qe_api_client/api_classes/engine_generic_variable_api.py,sha256=sWXZpE-GLfcMijmfORnDNrJ6lmXX3x5TRHlkEu_i0BQ,2027
 qe_api_client/api_classes/engine_global_api.py,sha256=G6QQHI36WOo7W25zg4Uz__gMSLC2ptNTvbBdElPzgZI,27535
-qe_api_client-2.2.0.dist-info/LICENSE,sha256=2bm9uFabQZ3Ykb_SaSU_uUbAj2-htc6WJQmS_65qD00,1073
-qe_api_client-2.2.0.dist-info/METADATA,sha256=ZvtVqTUoNFA_a70UPxJWIjUptydO1Ij42w5Yy_hF8B0,1995
-qe_api_client-2.2.0.dist-info/WHEEL,sha256=OVMc5UfuAQiSplgO0_WdW7vXVGAt9Hdd6qtN4HotdyA,91
-qe_api_client-2.2.0.dist-info/top_level.txt,sha256=m_43YagP8UtZgJHmZEfu0vlBNwt36M01-Qby2jByMnk,14
-qe_api_client-2.2.0.dist-info/RECORD,,
+qe_api_client-2.4.0.dist-info/LICENSE,sha256=2bm9uFabQZ3Ykb_SaSU_uUbAj2-htc6WJQmS_65qD00,1073
+qe_api_client-2.4.0.dist-info/METADATA,sha256=uXwa8Jwcq9-w4r0o0CbET_lwWPM87WLY1PwxUkJYBNo,2363
+qe_api_client-2.4.0.dist-info/WHEEL,sha256=nn6H5-ilmfVryoAQl3ZQ2l8SH5imPWFpm1A5FgEuFV4,91
+qe_api_client-2.4.0.dist-info/top_level.txt,sha256=m_43YagP8UtZgJHmZEfu0vlBNwt36M01-Qby2jByMnk,14
+qe_api_client-2.4.0.dist-info/RECORD,,

{qe_api_client-2.2.0.dist-info → qe_api_client-2.4.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.2.0)
+Generator: setuptools (75.8.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

qe_api_client/engine_helper.py

@@ -1,67 +0,0 @@
-import math
-
-from qe_api_client.api_classes.engine_app_api import EngineAppApi
-from qe_api_client.api_classes.engine_field_api import EngineFieldApi
-from qe_api_client.api_classes.engine_generic_object_api import EngineGenericObjectApi
-from qe_api_client.api_classes.engine_global_api import EngineGlobalApi
-import qe_api_client.structs as structs
-
-import pandas as pd
-
-
-def getDataFrame(connection, appHandle, measures, dimensions, selections={}):
-    engineGlobalApi = EngineGlobalApi(connection)
-    # Define Dimensions of hypercube
-    hc_inline_dim = structs.nx_inline_dimension_def(dimensions)
-
-    # Set sorting of Dimension by Measure
-    hc_mes_sort = structs.sort_criteria()
-
-    # Define Measure of hypercube
-    hc_inline_mes = structs.nx_inline_measure_def(measures)
-
-    # Build hypercube from above definition
-    hc_dim = structs.nx_dimension(hc_inline_dim)
-    hc_mes = structs.nx_measure("", hc_inline_mes, hc_mes_sort)
-
-    width = len(measures) + len(dimensions)
-    height = int(math.floor(10000 / width))
-    nx_page = structs.nx_page(0, 0, width, height)
-    hc_def = structs.hypercube_def("$", [hc_dim], [hc_mes], [nx_page])
-
-    engineAppApi = EngineAppApi(connection)
-    hc_response = engineAppApi.create_object(appHandle, "CH01", "Chart", "qHyperCubeDef", hc_def)  # NOQA
-    hc_handle = engineGlobalApi.get_handle(hc_response['qReturn'])
-
-    engineGenericObjectApi = EngineGenericObjectApi(connection)
-
-    engineFieldApi = EngineFieldApi(connection)
-
-    for field in selections.keys():
-        fieldHandle = engineGlobalApi.get_handle(engineAppApi.get_field(appHandle, field))  # NOQA
-        values = []
-        for selectedValue in selections[field]:
-            values.append({'qText': selectedValue})
-
-        engineFieldApi.select_values(fieldHandle, values)
-
-    i = 0
-    while i % height == 0:
-        nx_page = structs.nx_page(0, i, width, height)
-        hc_data = engineGenericObjectApi.get_hypercube_data(hc_handle, "/qHyperCubeDef", nx_page)  # NOQA
-        elems = hc_data["qDataPages"][0]['qMatrix']
-
-        df = pd.DataFrame()
-
-        for elem in elems:
-            j = 0
-            for dim in dimensions:
-                df.set_value(i, dim, elem[j]["qText"])
-                j += 1
-            for meas in measures:
-                df.set_value(i, meas, elem[j]["qNum"])
-                j += 1
-
-            i += 1
-
-    return df