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

qe_api_client/api_classes/engine_app_api.py

@@ -708,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_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

@@ -70,4 +70,9 @@ def generic_measure_properties(info, lb_meas_def, 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}
+            "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.3.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.3.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
 

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

@@ -1,17 +1,17 @@
 qe_api_client/__init__.py,sha256=bypB4CIjpHtf5Pu_NwtJajC69zqQD7qB9jo8cCX0B54,23
 qe_api_client/engine.py,sha256=SCTjKlhtir2kOMNDnfwd1Cz-Su6xxDk79GBUtAMgSpU,16900
-qe_api_client/engine_communicator.py,sha256=Va8Kz4cN6uyKLzV3JllBw08KbU4uDn8e-5pIm5Kmsfs,1291
-qe_api_client/structs.py,sha256=4672aQhsYI9pE3rEPyL9eVeAXx-9nVFgml9ZTEN3JX0,4257
+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=mP0bm_BqhcJCNHSFN5UQgzjQKjEZhG12mWruKPsBEWs,37311
+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.3.0.dist-info/LICENSE,sha256=2bm9uFabQZ3Ykb_SaSU_uUbAj2-htc6WJQmS_65qD00,1073
-qe_api_client-2.3.0.dist-info/METADATA,sha256=Uj6FJXU6ZdW6n9P2VQOcz24VTX74jvOpl0XWWfsgqKE,2138
-qe_api_client-2.3.0.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
-qe_api_client-2.3.0.dist-info/top_level.txt,sha256=m_43YagP8UtZgJHmZEfu0vlBNwt36M01-Qby2jByMnk,14
-qe_api_client-2.3.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.3.0.dist-info → qe_api_client-2.4.0.dist-info}/WHEEL

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