qe-api-client 1.0.0__tar.gz → 1.2.0__tar.gz

{qe_api_client-1.0.0 → qe_api_client-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qe-api-client
-Version: 1.0.0
+Version: 1.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-1.0.0 → qe_api_client-1.2.0}/qe_api_client/engine.py

@@ -3,24 +3,31 @@ import qe_api_client.engine_communicator as engine_communicator
 import qe_api_client.engine_field_api as engine_field_api
 import qe_api_client.engine_generic_object_api as engine_generic_object_api
 import qe_api_client.engine_global_api as engine_global_api
+import qe_api_client.engine_generic_variable_api as engine_generic_variable_api
+import qe_api_client.engine_generic_dimension_api as engine_generic_dimension_api
+import qe_api_client.engine_generic_measure_api as engine_generic_measure_api
 import qe_api_client.structs as structs
 
 
 class QixEngine:
 
-    def __init__(self, url, user_directory,
-                 user_id, ca_certs, certfile,
-                 keyfile, app_id=None):
+    def __init__(self, url, user_directory=None, user_id=None, ca_certs=None, certfile=None, keyfile=None, app_id=None):
         self.url = url
-        self.conn = engine_communicator.SecureEngineCommunicator(
-                    url, user_directory,
-                    user_id, ca_certs, certfile,
-                    keyfile, app_id
-                    )
+
+        # Check, if server or local connection available
+        if user_directory is None and user_id is None and ca_certs is None and certfile is None and keyfile is None:
+            self.conn = engine_communicator.EngineCommunicator(url)
+        else:
+            self.conn = engine_communicator.SecureEngineCommunicator(url, user_directory, user_id, ca_certs, certfile,
+                                                                     keyfile, app_id)
+
         self.ega = engine_global_api.EngineGlobalApi(self.conn)
         self.eaa = engine_app_api.EngineAppApi(self.conn)
         self.egoa = engine_generic_object_api.EngineGenericObjectApi(self.conn)
         self.efa = engine_field_api.EngineFieldApi(self.conn)
+        self.egva = engine_generic_variable_api.EngineGenericVariableApi(self.conn)
+        self.egda = engine_generic_dimension_api.EngineGenericDimensionApi(self.conn)
+        self.egma = engine_generic_measure_api.EngineGenericMeasureApi(self.conn)
         self.Structs = structs.Structs()
         self.app_handle = ''
 
@@ -36,7 +43,7 @@ class QixEngine:
         return self.eaa.do_reload_ex(self.app_handle)['qResult']['qSuccess']
 
     def open_app(self, app_obj):
-        opened_app = self.ega.open_doc(app_obj)['qReturn']
+        opened_app = self.ega.open_doc(app_obj)
         self.app_handle = self.ega.get_handle(opened_app)
         return opened_app['qGenericId']
 
@@ -124,7 +131,7 @@ class QixEngine:
         lb_param = {"qInfo": {"qId": "SLB01", "qType": "ListObject"},
                     "qListObjectDef": lb_def}
         listobj_handle = self.eaa.create_session_object(self.app_handle, lb_param)["qReturn"]["qHandle"]  # NOQA
-        val_list = self.egoa.get_layout(listobj_handle)["qLayout"]["qListObject"]["qDataPages"][0]["qMatrix"]  # NOQA
+        val_list = self.egoa.get_layout(listobj_handle)["qListObject"]["qDataPages"][0]["qMatrix"]  # NOQA
         val_n_state_list = []
         for val in val_list:
             val_n_state_list.append((val[0]["qText"], val[0]["qState"]))

{qe_api_client-1.0.0 → qe_api_client-1.2.0}/qe_api_client/engine_field_api.py

@@ -58,7 +58,7 @@ class EngineFieldApi:
 
     def clear(self, fld_handle):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": fld_handle,
-                          "method": "SelectExcluded",
+                          "method": "Clear",
                           "params": []})
         response = json.loads(self.engine_socket.send_call(self.engine_socket,
                                                            msg)

qe_api_client-1.2.0/qe_api_client/engine_generic_dimension_api.py

@@ -0,0 +1,16 @@
+import json
+
+
+class EngineGenericDimensionApi:
+
+    def __init__(self, socket):
+        self.engine_socket = socket
+
+    def get_dimension(self, handle, dimension_id):
+        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-1.2.0/qe_api_client/engine_generic_measure_api.py

@@ -0,0 +1,15 @@
+import json
+
+
+class EngineGenericMeasureApi:
+
+    def __init__(self, socket):
+        self.engine_socket = socket
+
+    def get_measure(self, handle, measure_id):
+        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-1.0.0 → qe_api_client-1.2.0}/qe_api_client/engine_generic_object_api.py

@@ -13,7 +13,7 @@ class EngineGenericObjectApi:
                                                            msg)
                               )
         try:
-            return response["result"]
+            return response["result"]["qLayout"]
         except KeyError:
             return response["error"]
 

qe_api_client-1.2.0/qe_api_client/engine_generic_variable_api.py

@@ -0,0 +1,24 @@
+import json
+
+
+class EngineGenericVariableApi:
+
+    def __init__(self, socket):
+        self.engine_socket = socket
+
+    def set_string_value(self, handle, str_val):
+        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):
+        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"]

{qe_api_client-1.0.0 → qe_api_client-1.2.0}/qe_api_client/engine_global_api.py

@@ -60,18 +60,12 @@ class EngineGlobalApi:
             return response["error"]
 
     # opens an app and returns an object with handle, generic id and type
-    def open_doc(self, app_name, user_name='',
-                 password='', serial='', no_data=False
-                 ):
-        msg = json.dumps(
-            {"jsonrpc": "2.0", "id": 0, "handle": -1,
-             "method": "OpenDoc", "params": [app_name, user_name,
-                                             password, serial,
-                                             no_data]})
-        response = json.loads(
-            self.engine_socket.send_call(self.engine_socket, msg))
+    def open_doc(self, app_name, user_name='', password='', serial='', no_data=False):
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": -1, "method": "OpenDoc",
+                          "params": [app_name, user_name, password, serial, no_data]})
+        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-1.0.0 → qe_api_client-1.2.0}/qe_api_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qe-api-client
-Version: 1.0.0
+Version: 1.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-1.0.0 → qe_api_client-1.2.0}/qe_api_client.egg-info/SOURCES.txt

@@ -6,7 +6,10 @@ qe_api_client/engine.py
 qe_api_client/engine_app_api.py
 qe_api_client/engine_communicator.py
 qe_api_client/engine_field_api.py
+qe_api_client/engine_generic_dimension_api.py
+qe_api_client/engine_generic_measure_api.py
 qe_api_client/engine_generic_object_api.py
+qe_api_client/engine_generic_variable_api.py
 qe_api_client/engine_global_api.py
 qe_api_client/engine_helper.py
 qe_api_client/structs.py

{qe_api_client-1.0.0 → qe_api_client-1.2.0}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
 
 setuptools.setup(
     name="qe-api-client",
-    version="1.0.0",
+    version="1.2.0",
     author="Rumen Vasilev",
     author_email="R.Vasilev@LRWorld.com",
     description="Python wrapper around Qlik Engine JSON API",

{qe_api_client-1.0.0 → qe_api_client-1.2.0}/test/test_app_api.py

@@ -22,7 +22,7 @@ class TestAppApi(unittest.TestCase):
         self.struct = Structs()
         self.app = self.ega.create_app("TestApp")['qAppId']
         opened_app = self.ega.open_doc(self.app)
-        self.app_handle = self.ega.get_handle(opened_app['qReturn'])
+        self.app_handle = self.ega.get_handle(opened_app)
 
     def test_add_alternate_state(self):
         response = self.eaa.add_alternate_state(self.app_handle, "MyState")

{qe_api_client-1.0.0 → qe_api_client-1.2.0}/test/test_field_api.py

@@ -21,7 +21,7 @@ class TestFieldApi(unittest.TestCase):
         self.struct = Structs()
         self.app = self.ega.create_app("TestApp")["qAppId"]
         opened_app = self.ega.open_doc(self.app)
-        self.app_handle = self.ega.get_handle(opened_app['qReturn'])
+        self.app_handle = self.ega.get_handle(opened_app)
         with open('../test/test_data/ctrl00_script.qvs') as f:
             script = f.read()
         self.eaa.set_script(self.app_handle, script)
@@ -46,7 +46,7 @@ class TestFieldApi(unittest.TestCase):
         sel_res = self.efa.select_values(self.fld_handle, values_to_select)
         self.assertTrue(sel_res["qReturn"] is True,
                         "Failed to perform selection")
-        val_mtrx = self.egoa.get_layout(self.lb_handle)["qLayout"]["qListObject"]["qDataPages"][0]["qMatrix"]  # NOQA
+        val_mtrx = self.egoa.get_layout(self.lb_handle)["qListObject"]["qDataPages"][0]["qMatrix"]  # NOQA
         self.assertEqual(val_mtrx[0][0]["qState"],
                          "S",
                          "Failed to select first value")
@@ -54,7 +54,7 @@ class TestFieldApi(unittest.TestCase):
                          "X",
                          "Failed to exclude fifth value")
         self.eaa.clear_all(self.app_handle)
-        val_mtrx = self.egoa.get_layout(self.lb_handle)["qLayout"]["qListObject"]["qDataPages"][0]["qMatrix"]  # NOQA
+        val_mtrx = self.egoa.get_layout(self.lb_handle)["qListObject"]["qDataPages"][0]["qMatrix"]  # NOQA
         self.assertEqual(val_mtrx[0][0]["qState"],
                          "O",
                          "Failed to clear selection")

{qe_api_client-1.0.0 → qe_api_client-1.2.0}/test/test_global_api.py

@@ -37,14 +37,14 @@ class TestGlobalApi(unittest.TestCase):
         # print response_copy
         response_open = self.ega.open_doc("test_app")
         # response_open = self.ega.open_doc_ex("test_app_asdf")
-        self.assertEqual(response_open['qReturn']["qHandle"], 1,
+        self.assertEqual(response_open["qHandle"], 1,
                          "Failed to retrieve a proper document "
                          "handle with open_doc method")
-        self.assertTrue(response_open['qReturn']["qGenericId"].
+        self.assertTrue(response_open["qGenericId"].
                         endswith(".qvf"),
                         'Generic id does not contain any app '
                         'file extension using open_doc method')
-        self.assertEqual(response_open['qReturn']["qType"], "Doc",
+        self.assertEqual(response_open["qType"], "Doc",
                          'Unknown doc type returned using open_doc method')
         response_get_active_doc = self.ega.get_active_doc()
         self.assertEqual(response_get_active_doc['qReturn']["qHandle"], 1,

{qe_api_client-1.0.0 → qe_api_client-1.2.0}/test/test_pyqlikengine.py

@@ -12,7 +12,7 @@ class TestQixEngine(unittest.TestCase):
         self.assertTrue(app_exists == "App already exists",
                         'Failed to handle existing app exception')
         self.opened_app = self.qixe.open_app(app)
-        with open('../test_data/ctrl00_script.qvs') as f:
+        with open('./test_data/ctrl00_script.qvs') as f:
             script = f.read()
         self.assertTrue(self.qixe.load_script(script), 'Failed to load script')