qe-api-client 2.8.0__tar.gz → 3.0.0__tar.gz

{qe_api_client-2.8.0 → qe_api_client-3.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qe-api-client
-Version: 2.8.0
+Version: 3.0.0
 Summary: Python client for the Qlik Engine JSON API
 Home-page: https://github.com/lr-bicc/qe-api-client
 Author: Rumen Vasilev

{qe_api_client-2.8.0 → qe_api_client-3.0.0}/qe_api_client/api_classes/engine_app_api.py

@@ -26,7 +26,7 @@ class EngineAppApi:
         """
         self.engine_socket = socket
 
-    def get_script(self, doc_handle):
+    def get_script(self, doc_handle: int):
         """
         Retrieves the script of the app identified by the document handle.
 
@@ -43,7 +43,7 @@ class EngineAppApi:
         except KeyError:
             return response['error']
 
-    def set_script(self, doc_handle, script):
+    def set_script(self, doc_handle: int, script):
         """
         Sets the script of the app identified by the document handle.
 
@@ -61,7 +61,7 @@ class EngineAppApi:
         except KeyError:
             return response['error']
 
-    def do_reload(self, doc_handle, param_list=[]):
+    def do_reload(self, doc_handle: int, param_list=[]):
         """
         Triggers a reload of the app identified by the document handle.
 
@@ -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: int, param_list={}):
         """
         Triggers an extended reload of the app identified by the document handle.
 
@@ -98,7 +98,7 @@ class EngineAppApi:
         except KeyError:
             return response['error']
 
-    def get_app_layout(self, doc_handle):
+    def get_app_layout(self, doc_handle: int):
         """
         Retrieves the layout structure of the app identified by the document handle.
 
@@ -115,7 +115,7 @@ class EngineAppApi:
         except KeyError:
             return response['error']
 
-    def get_object(self, app_handle, object_id):
+    def get_object(self, app_handle: int, object_id: str):
         """
         Retrieves a specific object from the app identified by the document handle.
 
@@ -134,7 +134,28 @@ class EngineAppApi:
         except KeyError:
             return response['error']
 
-    def get_field(self, doc_handle, field_name, state_name=""):
+
+    def get_objects(self, app_handle: int, options: dict):
+        """
+        Retrieves a specific object from the app identified by the document handle.
+
+        Parameters:
+            app_handle (int): The handle identifying the app document.
+            object_id (str): The ID of the object to retrieve.
+
+        Returns:
+            dict: The retrieved object (qReturn). In case of an error, returns the error information.
+        """
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": app_handle, "method": "GetObjects",
+                          "params": {"qOptions": options}})
+        response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
+        try:
+            return response["result"]["qList"]
+        except KeyError:
+            return response["error"]
+
+
+    def get_field(self, doc_handle: int, field_name, state_name=""):
         """
         Retrieves a specific field from the app identified by the document handle.
 
@@ -154,7 +175,7 @@ class EngineAppApi:
         except KeyError:
             return response['error']
 
-    def create_object(self, doc_handle, prop):
+    def create_object(self, doc_handle: int, prop):
         """
         Creates a new object in the app identified by the document handle.
 
@@ -177,7 +198,7 @@ class EngineAppApi:
     # You can create multiple states within a Qlik Sense app and apply these states to specific objects within the app.  # NOQA
     # Objects in a given state are not affected by user selections in the other states.  # NOQA
     # Call GetAppLayout() afterwards to get the latest states
-    def add_alternate_state(self, doc_handle, state_name):
+    def add_alternate_state(self, doc_handle: int, state_name):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "AddAlternateState",
                           "params": [state_name]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -188,7 +209,7 @@ class EngineAppApi:
 
     # AddFieldFromExpression method: Adds a field on the fly. !! The expression of a field on the fly is persisted but  # NOQA
     # not its values. !!
-    def add_field_from_expression(self, doc_handle, field_name, expr_value):
+    def add_field_from_expression(self, doc_handle: int, field_name, expr_value):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "AddFieldFromExpression",
                           "params": [field_name, expr_value]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -199,7 +220,7 @@ class EngineAppApi:
 
     # CheckExpression method: Checks whether an expression is valid or not
     # qErrorMsg is empty if it's valid
-    def check_expression(self, doc_handle, expr_value):
+    def check_expression(self, doc_handle: int, expr_value):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "CheckExpression",
                           "params": [expr_value]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -211,7 +232,7 @@ class EngineAppApi:
     # CheckScriptSyntax method: Checks whether a load script is valid or not
     # Used AFTER doing SetScript method
     # errors are displayed in an array discussing positions of characters in script where failing  # NOQA
-    def check_script(self, doc_handle):
+    def check_script(self, doc_handle: int):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "CheckScriptSyntax", "params": {}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
@@ -219,7 +240,7 @@ class EngineAppApi:
         except KeyError:
             return response['error']
 
-    def clear_all(self, doc_handle, locked_also=False, alt_state=""):
+    def clear_all(self, doc_handle: int, locked_also=False, alt_state=""):
         """
         Clear selections in fields for current state. Locked fields are not cleared by default.
 
@@ -239,7 +260,7 @@ class EngineAppApi:
     # CreateConnection method: Creates a connection. A connection indicates from which data source, the data should  # NOQA
     # be taken. The connection can be: an ODBC connection, OLEDB connection, a custom connection, a folder connection  # NOQA
     #  (lib connection), an internet connection, Single Sign-On
-    def create_connection(self, doc_handle, connect_name, connect_string, connect_type, user_name, password,
+    def create_connection(self, doc_handle: int, connect_name, connect_string, connect_type, user_name, password,
                           mod_date="", meta="", sso_passthrough="LOG_ON_SERVICE_USER"):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "CreateConnection",
                           "params": [{"qName": connect_name, "qMeta": meta, "qConnectionString": connect_string,
@@ -255,7 +276,7 @@ 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_dimension(self, doc_handle, prop):
+    def create_dimension(self, doc_handle: int, prop):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "CreateDimension",
                           "params": {"qProp": prop}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -265,7 +286,7 @@ class EngineAppApi:
             return response['error']
 
     # DestroyDimension method: Removes a dimension
-    def destroy_dimension(self, doc_handle, dim_id):
+    def destroy_dimension(self, doc_handle: int, dim_id):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "DestroyDimension",
                           "params": {"qId": dim_id}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -275,7 +296,7 @@ class EngineAppApi:
             return response["error"]
 
     # DestroyMeasure method: Removes a measure
-    def destroy_measure(self, doc_handle, measure_id):
+    def destroy_measure(self, doc_handle: int, measure_id):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "DestroyDimension",
                           "params": [{measure_id}]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -285,7 +306,7 @@ class EngineAppApi:
             return response['error']
 
     # DestroyObject method: Removes an app object. The children of the object (if any) are removed as well.  # NOQA
-    def destroy_object(self, doc_handle, object_id):
+    def destroy_object(self, doc_handle: int, object_id):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "DestroyObject",
                           "params": [{object_id}]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -295,7 +316,7 @@ class EngineAppApi:
             return response['error']
 
     # DestroySessionObject method: Removes a session object. The children of the object (if any) are removed as well.  # NOQA
-    def destroy_session_object(self, doc_handle, object_id):
+    def destroy_session_object(self, doc_handle: int, object_id):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "DestroySessionObject",
                           "params": [{object_id}]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -305,7 +326,7 @@ class EngineAppApi:
             return response['error']
 
     # DestroySessionVariable method: Removes an transient variable.
-    def destroy_session_variable(self, doc_handle, var_id):
+    def destroy_session_variable(self, doc_handle: int, var_id):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "DestroySessionVariable",
                           "params": [{var_id}]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -317,7 +338,7 @@ class EngineAppApi:
     # DestroyVariableById method: Removes a varable..
     # Script-defined variables cannot be removed using the DestroyVariableById method or the  # NOQA
     # DestroyVariableByName method.
-    def destroy_variable_by_id(self, doc_handle, var_name):
+    def destroy_variable_by_id(self, doc_handle: int, var_name):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "DestroyVariableById",
                           "params": [{var_name}]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -331,7 +352,7 @@ 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_measure(self, doc_handle, prop):
+    def create_measure(self, doc_handle: int, 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))
@@ -364,9 +385,9 @@ class EngineAppApi:
     # ### Example:  The variable x contains the text string Sum(Sales). In a chart, you define the expression $(x)/12.  # NOQA
     # The effect is exactly the same as having the chart expression Sum(Sales)/12. However, if you change the value of the variable x to Sum(Budget),  # NOQA
     # the data in the chart are immediately recalculated with the expression interpreted as Sum(Budget)/12.  # NOQA
-    def create_session_variable(self, doc_handle, var_id="", var_name="", var_comment="", var_def=""):
+    def create_session_variable(self, app_handle: int, var_id="", var_name="", var_comment="", var_def=""):
         msg = json.dumps(
-            {"jsonrpc": "2.0", "id": 0, "handle": doc_handle,
+            {"jsonrpc": "2.0", "id": 0, "handle": app_handle,
              "method": "CreateSessionVariable", "params": [{
                 "qInfo": {
                     "qId": var_id,
@@ -393,8 +414,8 @@ class EngineAppApi:
     # The effect is exactly the same as having the chart expression Sum(Sales)/12.   # NOQA
     # However, if you change the value of the variable x to Sum(Budget),
     # the data in the chart are immediately recalculated with the expression interpreted as Sum(Budget)/12.  # NOQA
-    def create_variable(self, doc_handle, var_id="", var_name="", var_comment="", var_def=""):
-        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle,
+    def create_variable(self, app_handle: int, var_id="", var_name="", var_comment="", var_def=""):
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": app_handle,
                           "method": "CreateVariable", "params": [{
                                 "qInfo": {
                                     "qId": var_id,
@@ -435,7 +456,7 @@ 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, file_name=""):
+    def do_save(self, doc_handle: int, 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))
@@ -446,8 +467,8 @@ class EngineAppApi:
 
     # Evaluate method: Evaluates an expression as a string. (Actually uses EvaluateEx, which is better for giving the data type back to python)  # NOQA
     # Parameters: qExpression
-    def expr_eval(self, doc_handle, expr):
-        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "EvaluateEx",
+    def expr_eval(self, app_handle: int, expr):
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": app_handle, "method": "EvaluateEx",
                           "params": {"qExpression": expr}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
@@ -456,8 +477,8 @@ class EngineAppApi:
             return response['error']
 
     # GetAllInfos method: Get the identifier and the type of any generic object in an app by using the GetAllInfos method.  # NOQA
-    def get_all_infos(self, doc_handle):
-        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetAllInfos", "params": []})
+    def get_all_infos(self, app_handle: int):
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": app_handle, "method": "GetAllInfos", "params": []})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
             return response['result']['qInfos']
@@ -465,7 +486,7 @@ class EngineAppApi:
             return response['error']
 
     # GetAppProperties method: Gets the properties of an app.
-    def get_app_properties(self, doc_handle):
+    def get_app_properties(self, doc_handle: int):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetAppProperties", "params": []})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
@@ -475,7 +496,7 @@ class EngineAppApi:
 
     # GetConnection method: Retrieves a connection and returns: The creation time of the connection, The identifier of  # NOQA
     # the connection, The type of the connection, The name of the connection, The connection string  # NOQA
-    def get_connection(self, doc_handle, connection_id):
+    def get_connection(self, doc_handle: int, connection_id):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetConnection",
                           "params": [connection_id]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -485,7 +506,7 @@ class EngineAppApi:
             return response['error']
 
     # GetConnections method: Lists the connections in an app
-    def get_connections(self, doc_handle):
+    def get_connections(self, doc_handle: int):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetConnections", "params": []})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
@@ -494,7 +515,7 @@ class EngineAppApi:
             return response['error']
 
     # GetDatabaseInfo: Get information about an ODBC, OLEDB or CUSTOM connection  # NOQA
-    def get_db_info(self, doc_handle, connection_id):
+    def get_db_info(self, doc_handle: int, connection_id):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetDatabaseInfo",
                           "params": [connection_id]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -504,7 +525,7 @@ class EngineAppApi:
             return response['error']
 
     # GetDatabaseOwners: List the owners of a database for a ODBC, OLEDB or CUSTOM connection  # NOQA
-    def get_db_owners(self, doc_handle, connection_id):
+    def get_db_owners(self, doc_handle: int, connection_id):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetDatabaseOwners",
                           "params": [connection_id]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -514,7 +535,7 @@ class EngineAppApi:
             return response['error']
 
     # GetDatabases: List the databases of a ODBC, OLEDB or CUSTOM connection
-    def get_databases(self, doc_handle, connection_id):
+    def get_databases(self, doc_handle: int, connection_id):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetDatabases",
                           "params": [connection_id]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -525,7 +546,7 @@ class EngineAppApi:
 
     # GetDatabaseTableFields: List the fields in a table for a ODBC, OLEDB or CUSTOM connection  # NOQA
     # Parameters taken are: connection_id (mandatory), db_name, db_owner, table_name (mandatory)  # NOQA
-    def get_db_table_fields(self, doc_handle, connection_id, db_name="", db_owner="", table_name=""):
+    def get_db_table_fields(self, doc_handle: int, connection_id, db_name="", db_owner="", table_name=""):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetDatabaseTableFields",
                           "params": [connection_id, db_name, db_owner, table_name]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -536,7 +557,7 @@ class EngineAppApi:
 
     # GetDatabaseTablePreview: Preview the data in the fields in a table for a ODBC, OLEDB or CUSTOM connection  # NOQA
     # Parameters taken are: connection_id (mandatory), db_name, db_owner, table_name (mandatory)  # NOQA
-    def get_db_table_preview(self, doc_handle, connection_id, db_name="", db_owner="", table_name=""):
+    def get_db_table_preview(self, doc_handle: int, connection_id, db_name="", db_owner="", table_name=""):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetDatabaseTablePreview",
                           "params": [connection_id, db_name, db_owner, table_name]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -547,7 +568,7 @@ class EngineAppApi:
 
     # GetDatabaseTables: List the tables in a database for a specific owner and for a ODBC, OLEDB or CUSTOM connection  # NOQA
     # Parameters taken are: connection_id (mandatory), db_name, db_owner
-    def get_db_tables(self, doc_handle, connection_id, db_name="", db_owner=""):
+    def get_db_tables(self, doc_handle: int, connection_id, db_name="", db_owner=""):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetDatabaseTables",
                           "params": [connection_id, db_name, db_owner]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -560,7 +581,7 @@ class EngineAppApi:
     # GetEmptyScript: Creates a script that contains one section. This section contains Set statements that give  # NOQA
     # localized information from the regional settings of the computer.
     # Parameter: none
-    def get_empty_script(self, doc_handle):
+    def get_empty_script(self, doc_handle: int):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetEmptyScript", "params": []})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
@@ -570,7 +591,7 @@ class EngineAppApi:
 
     # GetFieldDescription: Get the description of a field
     # Parameter: field name
-    def get_field_descr(self, doc_handle, field_name):
+    def get_field_descr(self, doc_handle: int, field_name):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetFieldDescription",
                           "params": {"qFieldName": field_name}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -585,7 +606,7 @@ class EngineAppApi:
         # qRelativePath: Path of the connection file
         # qDataFormat: Type of the file
         # qTable (MOSTLY MANDATORY): Name of the table ***This parameter must be set for XLS, XLSX, HTML and XML files.***  # NOQA
-    def get_file_table_fields(self, doc_handle, connection_id,
+    def get_file_table_fields(self, doc_handle: int, connection_id,
                               rel_path="", data_fmt="", table_name=""):
         msg = json.dumps(
             {"jsonrpc": "2.0", "id": 0, "handle": doc_handle,
@@ -605,7 +626,7 @@ class EngineAppApi:
         # qRelativePath: Path of the connection file
         # qDataFormat: Type of the file
         # qTable (MOSTLY MANDATORY): Name of the table ***This parameter must be set for XLS, XLSX, HTML and XML files.***  # NOQA
-    def get_file_table_preview(self, doc_handle, connection_id, rel_path="", data_fmt="", table_name=""):
+    def get_file_table_preview(self, doc_handle: int, connection_id, rel_path="", data_fmt="", table_name=""):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetFileTablePreview",
                           "params": [connection_id, rel_path, {"qType": data_fmt}, table_name]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -620,7 +641,7 @@ class EngineAppApi:
         # qRelativePath: Path of the connection file
         # qDataFormat: Type of the file (XML, JSON)
         # qTable (MOSTLY MANDATORY): Name of the table ***This parameter must be set for XLS, XLSX, HTML and XML files.***  # NOQA
-    def get_file_table_ex(self, doc_handle, connection_id,
+    def get_file_table_ex(self, doc_handle: int, connection_id,
                           rel_path="", data_fmt=""):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetFileTablesEx",
                           "params": [connection_id, rel_path, {"qType": data_fmt}]})
@@ -635,7 +656,7 @@ class EngineAppApi:
         # qConnectionId (MANDATORY): Identifier of the connection.
         # qRelativePath: Path of the connection file
         # qDataFormat: Type of the file (XML, JSON)
-    def get_file_tables(self, doc_handle, connection_id, rel_path="", data_fmt=""):
+    def get_file_tables(self, doc_handle: int, connection_id, rel_path="", data_fmt=""):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetFileTables",
                           "params": [connection_id, rel_path, {"qType": data_fmt}]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -646,7 +667,7 @@ class EngineAppApi:
 
     # GetFolderItemsForConnection method: List the items for a folder connection  # NOQA
     # Parameter: connection_id
-    def get_folder_items_for_connection(self, doc_handle, connection_id):
+    def get_folder_items_for_connection(self, doc_handle: int, connection_id):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetFolderItemsForConnection",
                           "params": [connection_id]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -656,7 +677,7 @@ class EngineAppApi:
             return response['error']
 
     # 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):
+    def get_lineage(self, doc_handle: int):
         """
         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.
@@ -674,7 +695,7 @@ class EngineAppApi:
         except KeyError:
             return response['error']
 
-    def create_session_object(self, doc_handle, prop):
+    def create_session_object(self, doc_handle: int, prop):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "CreateSessionObject",
                           "params": {"qProp": prop}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -683,7 +704,7 @@ class EngineAppApi:
         except KeyError:
             return response['error']
 
-    def get_set_analysis(self, doc_handle, state_name="", bookmark_id=""):
+    def get_set_analysis(self, doc_handle: int, state_name="", bookmark_id=""):
         msg = json.dumps({"jsonrpc": "2.0", "id": 3, "handle": doc_handle, "method": "GetSetAnalysis",
                           "params": {"qStateName": state_name, "qBookmarkId": bookmark_id}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -701,7 +722,7 @@ class EngineAppApi:
         except KeyError:
             return response['error']
 
-    def get_variable_by_id(self, doc_handle, variable_id):
+    def get_variable_by_id(self, doc_handle: int, variable_id):
         """
         Gets the handle of a variable.
 
@@ -715,6 +736,66 @@ class EngineAppApi:
         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']
+
+
+    def create_bookmark(self, doc_handle: int, prop: dict):
+        """
+        Creates a bookmark.
+
+        Parameters:
+            doc_handle (int): The handle identifying the document.
+            prop (dict): Bookmark properties.
+
+        Returns:
+            dict: The handle of the generic bookmark.
+        """
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "CreateBookmark",
+                          "params": {"qProp": prop}})
+        response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
+        try:
+            return response['result']['qReturn']
+        except KeyError:
+            return response['error']
+
+
+    def get_bookmarks(self, doc_handle: int, options: dict):
+        """
+        Returns all bookmarks compatible with options.
+
+        Parameters:
+            doc_handle (int): The handle identifying the document.
+            qOptions (dict): Bookmark type filter and requested properties.
+
+        Returns:
+            list: The resulting list.
+        """
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetBookmarks",
+                          "params": {"qOptions": options}})
+        response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
+        try:
+            return response['result']
+        except KeyError:
+            return response['error']
+
+
+    def get_bookmark(self, app_handle: int, bookmark_id: str):
+        """
+        Retrieves a specific bookmark from the app identified by the document handle.
+
+        Parameters:
+            app_handle (int): The handle identifying the app document.
+            bookmark_id (str): The ID of the bookmark to retrieve.
+
+        Returns:
+            dict: The retrieved object (qReturn). In case of an error, returns the error information.
+        """
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": app_handle, "method": "GetBookmark",
+                          "params": {"qId": bookmark_id}})
+        response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
             return response['result']['qReturn']
         except KeyError:

{qe_api_client-2.8.0 → qe_api_client-3.0.0}/qe_api_client/api_classes/engine_generic_object_api.py

@@ -124,7 +124,7 @@ class EngineGenericObjectApi:
         except KeyError:
             return response["error"]
 
-    def get_hypercube_data(self, handle, path="/qHyperCubeDef", pages={}):
+    def get_hypercube_data(self, handle: int, path: str, pages: list):
         """
         Retrieves the data from a specific hypercube in a generic object.
 
@@ -137,14 +137,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": {"qPath": path, "qPages": [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: int, path: str, pages: list):
         """
         Retrieves the pivot data from a specific hypercube in a generic object.
 
@@ -157,14 +157,14 @@ 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": "GetHyperCubePivotData",
-                          "params": {"qPath": path, "qPages": [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_stack_data(self, handle, path="/qHyperCubeDef", pages={}, max_no_cells=10000):
+    def get_hypercube_stack_data(self, handle: int, path: str, pages: list, max_no_cells: int = 10000):
         """
         Retrieves the values of a stacked pivot table. It is possible to retrieve specific pages of data.
 
@@ -179,7 +179,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": {"qPath": path, "qPages": [pages], "qMaxNbrCells": 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"]
@@ -224,5 +224,44 @@ class EngineGenericObjectApi:
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
             return response["result"]["qProp"]
+        except KeyError:
+            return response["error"]
+
+
+    def embed_snapshot_object(self, handle: int, snapshot_id: str):
+        """
+        Adds a snapshot to a generic object. Only one snapshot can be embedded in a generic object. If you embed a
+        snapshot in an object that already contains a snapshot, the new snapshot overwrites the previous one.
+
+        Parameters:
+            handle (int): The handle identifying the generic object.
+            snapshot_id (str): The id of the snapshot to be embeded.
+
+        Returns:
+            update
+        """
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": handle, "method": "EmbedSnapshotObject",
+                          "params": {"qId": snapshot_id}})
+        response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
+        try:
+            return response["result"]
+        except KeyError:
+            return response["error"]
+
+
+    def get_parent(self, handle: int):
+        """
+        Returns the type of the object and the corresponding handle to the parent object in the hiearchy.
+
+        Parameters:
+            handle (int): The handle identifying the generic object.
+
+        Returns:
+            { "qType": "GenericObject", "qHandle": <handle of the object> }
+        """
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": handle, "method": "GetParent", "params": {}})
+        response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
+        try:
+            return response["result"]["qReturn"]
         except KeyError:
             return response["error"]