Py4HEAppE 1.0.0__py3-none-any.whl

py4heappe/cli/information.py

@@ -0,0 +1,163 @@
+import json
+import typer
+
+import py4heappe.cli.configuration as configuration
+import py4heappe.core.base.utils as utils
+import py4heappe.core as heappeCore
+
+from py4heappe.core.base import exceptions
+from py4heappe.core  import rest 
+
+
+app = typer.Typer(name="HEAppEInfoCLI", no_args_is_help=True, pretty_exceptions_short=True)
+
+def get_hpc_project():
+    try:
+        utils.print_and_log("Fetching computational project …")
+        parameters = {
+            "_preload_content": False,
+            "SessionCode": utils.load_stored_session()
+        }    
+
+        response = heappeCore.UserAndLimitationManagementApi(configuration.get_api_instance()).heappe_user_and_limitation_management_projects_for_current_user_get(**parameters)
+        project = next((f["Project"] for f in json.loads(response.data)if f["Project"]["AccountingString"] == configuration.get_project_from_configuration()), None)
+
+        if project is None:
+            raise exceptions.Py4HEAppEInternalException("The computational project does not exist.") from None
+
+        return project
+
+    except rest.ApiException as exception:
+        try:
+            response_data = json.loads(exception.body)
+            raise exceptions.Py4HEAppEAPIInternalException(response_data['title'], response_data['detail'], response_data['status']) from None
+        except json.JSONDecodeError:
+            raise exceptions.Py4HEAppEInternalException("Link to a HEAppE instance is not set or valid. Please check Conf Init option.") from None
+    
+    except exceptions.Py4HEAppEInternalException as exception:
+         raise exceptions.Py4HEAppEInternalException(exception.message) from None 
+           
+    except Exception as exception:
+        raise exceptions.Py4HEAppEInternalException(f"Other exception: {str(exception)}") from None
+    
+@app.command(name="Version")
+def get_api_version():
+    """Version information"""
+    try:
+        utils.print_and_log("Fetching HEAppE API version information …")
+        parameters = {
+            "_preload_content": False,
+            "SessionCode": utils.load_stored_session()
+        }    
+
+        response= heappeCore.ManagementApi(configuration.get_api_instance()).heappe_management_version_information_get(**parameters)
+        version: str = json.loads(response.data)["Version"]
+        utils.print_and_log(f"\nVersion of API: {version}")
+
+    except rest.ApiException as exception:
+        try:
+            response_data = json.loads(exception.body)
+            raise exceptions.Py4HEAppEAPIException(response_data['title'], response_data['detail'], response_data['status']) from None
+        except json.JSONDecodeError:
+            raise exceptions.Py4HEAppEException("Link to a HEAppE instance is not set or valid. Please check Conf Init option.") from None
+
+    except exceptions.Py4HEAppEInternalException as exception:
+         raise exceptions.Py4HEAppEException(exception.message) from None 
+    
+    except Exception as exception:
+        raise exceptions.Py4HEAppEInternalException(f"Other exception: {str(exception)}") from None
+
+@app.command(name="ClusterInfo")
+def get_cluster_information():
+    """Cluster information"""
+    try:
+        utils.print_and_log("Fetching cluster information …")
+        parameters = {
+            "_preload_content": False
+        }    
+
+        response= heappeCore.ClusterInformationApi(configuration.get_api_instance()).heappe_cluster_information_list_available_clusters_get(**parameters)
+        print(f"\nCluster information:\n{json.dumps(json.loads(response.data), indent = 3)}")
+
+    except rest.ApiException as exception:
+        try:
+            response_data = json.loads(exception.body)
+            raise exceptions.Py4HEAppEAPIException(response_data['title'], response_data['detail'], response_data['status']) from None
+        except json.JSONDecodeError:
+            raise exceptions.Py4HEAppEException("Link to a HEAppE instance is not set or valid. Please check Conf Init option.") from None
+
+    except exceptions.Py4HEAppEInternalException as exception:
+         raise exceptions.Py4HEAppEException(exception.message) from None 
+    
+    except Exception as exception:
+        raise exceptions.Py4HEAppEInternalException(f"Other exception: {str(exception)}") from None
+
+@app.command("ListParamsFromGeneric")
+def get_parameters_from_generic_cmd_template_script(id:int = typer.Option(..., help='Id (Command template)'),
+                                                    userScriptPath:str = typer.Option(None, help='Path to executable file/script')):
+    """List command template parameters from generic command template"""
+    try:
+        utils.print_and_log("Fetching command template parameters from generic command template …")
+        body = {
+            "_preload_content": False,
+            "body": {
+                "UserScriptPath": userScriptPath,
+                "CommandTemplateId": id,
+                "ProjectId": get_hpc_project()["Id"],
+                "SessionCode": utils.load_stored_session()
+            }
+        }
+
+        response = heappeCore.ClusterInformationApi(configuration.get_api_instance()).heappe_cluster_information_request_command_template_parameters_name_post(**body)
+        print(f"\nCommand template parameters:\n{json.dumps(json.loads(response.data), indent = 3)}")
+
+    except rest.ApiException as exception:
+        try:
+            response_data = json.loads(exception.body)
+            raise exceptions.Py4HEAppEAPIException(response_data['title'], response_data['detail'], response_data['status']) from None
+        except json.JSONDecodeError:
+            raise exceptions.Py4HEAppEException("Link to a HEAppE instance is not set or valid. Please check Conf Init option.") from None
+
+    except exceptions.Py4HEAppEAPIInternalException as exception:
+         raise exceptions.Py4HEAppEException(exception.message) from None
+
+    except exceptions.Py4HEAppEInternalException as exception:
+         raise exceptions.Py4HEAppEException(exception.message) from None 
+    
+    except Exception as exception:
+        raise exceptions.Py4HEAppEInternalException(f"Other exception: {str(exception)}") from None
+    
+@app.command(name="ClusterNodeUsage")
+def get_cluster_node_usage(clusterNodeId :int = typer.Option(default=...,  help='Id (Cluster node type)')):
+    """Cluster node usage information"""
+    try:
+        utils.print_and_log("Fetching cluster information …")
+        parameters = {
+            "_preload_content": False,
+            "ClusterNodeId": clusterNodeId,
+            "ProjectId": get_hpc_project()["Id"],
+            "SessionCode": utils.load_stored_session(),
+        }    
+    
+        response= heappeCore.ClusterInformationApi(configuration.get_api_instance()).heappe_cluster_information_current_cluster_node_usage_get(**parameters)
+        print(f"\nCluster node type usage:\n{json.dumps(json.loads(response.data), indent = 3)}")
+
+    except rest.ApiException as exception:
+        try:
+            response_data = json.loads(exception.body)
+            raise exceptions.Py4HEAppEAPIException(response_data['title'], response_data['detail'], response_data['status']) from None
+        except json.JSONDecodeError:
+            raise exceptions.Py4HEAppEException("Link to a HEAppE instance is not set or valid. Please check Conf Init option.") from None
+
+    except exceptions.Py4HEAppEAPIInternalException as exception:
+         raise exceptions.Py4HEAppEException(exception.message) from None
+
+    except exceptions.Py4HEAppEInternalException as exception:
+         raise exceptions.Py4HEAppEException(exception.message) from None 
+    
+    except Exception as exception:
+        raise exceptions.Py4HEAppEInternalException(f"Other exception: {str(exception)}") from None
+
+
+if __name__ == '__main__':
+    app()

py4heappe/cli/job_management.py

@@ -0,0 +1,211 @@
+# import json
+# import typer
+
+# import heappeac_v4.cli.configuration as configuration
+# import heappeac_v4.cli.information as infoCLI
+# import heappeac_v4.core.base.utils as utils
+# import heappeac_v4.core as heappeCore
+
+# from heappeac_v4.core.base import exceptions
+# from heappeac_v4.core  import rest 
+
+
+# app = typer.Typer(name="JobMgmtCLI", no_args_is_help=True, pretty_exceptions_show_locals=False)
+
+# @app.command(name="Create")
+# def create_job():
+#     """Create HPC job"""
+#     try:
+#         print("Creating HPC Job ...") 
+#         projectId : int = infoCLI.get_hpc_project()["Id"]
+#         parameters = {
+#             "_preload_content": False,
+#             "ProjectId": projectId,
+#             "SessionCode": utils.load_stored_session()
+#         }
+
+
+       
+#     except rest.ApiException as exception:
+#         response_data=json.loads(exception.body)
+#         raise exceptions.Py4HEAppEException(response_data['title'], response_data['detail'], response_data['status']) from None
+    
+#     except Exception as exception:
+#         raise exceptions.Py4HEAppEException("Link to a HEAppE instance is not set or valid. Please check Conf Init option.") from None
+
+# @app.command(name="Submit")
+# def submit_job(id:int = typer.Option(..., help='Created HPC Job Info Identifier')):
+#     """Submit created HPC job"""
+#     try:
+#         print("Submitting HPC Job ...") 
+#         body = {
+#             "_preload_content": False,
+#             "CreatedJobInfoId": id,
+#             "SessionCode": utils.load_stored_session()
+#         }
+
+#         _ = heappeCore.JobManagementApi(configuration.get_api_instance()).heappe_job_management_submit_job_put(**body)
+#         print("Job submitted successfully")
+       
+#     except rest.ApiException as exception:
+#         response_data=json.loads(exception.body)
+#         raise exceptions.Py4HEAppEException(response_data['title'], response_data['detail'], response_data['status']) from None
+    
+#     except Exception as exception:
+#         raise exceptions.Py4HEAppEException("Link to a HEAppE instance is not set or valid. Please check Conf Init option.") from None  
+
+# @app.command(name="Cancel")
+# def cancel_job(id:int = typer.Option(..., help='Created HPC Job Info Identifier')):
+#     """Cancel Execution of HPC job"""
+#     try:
+#         print("Cancellation Execution of HPC Job ...") 
+#         body = {
+#             "_preload_content": False,
+#             "CreatedJobInfoId": id,
+#             "SessionCode": utils.load_stored_session()
+#         }
+
+#         _ = heappeCore.JobManagementApi(configuration.get_api_instance()).heappe_job_management_cancel_job_put(**body)
+#         print("Job cancelled successfully")
+       
+#     except rest.ApiException as exception:
+#         response_data=json.loads(exception.body)
+#         raise exceptions.Py4HEAppEException(response_data['title'], response_data['detail'], response_data['status']) from None
+    
+#     except Exception as exception:
+#         raise exceptions.Py4HEAppEException("Link to a HEAppE instance is not set or valid. Please check Conf Init option.") from None  
+
+
+# @app.command(name="Remove")
+# def remove_job(id:int = typer.Option(..., help='Created HPC Job Info Identifier')):
+#     """Remove HPC job"""
+#     try:
+#         print("Removing of HPC Job ...") 
+#         body = {
+#             "_preload_content": False,
+#             "CreatedJobInfoId": id,
+#             "SessionCode": utils.load_stored_session()
+#         }
+
+#         _ = heappeCore.JobManagementApi(configuration.get_api_instance()).heappe_job_management_delete_job_delete(**body)
+#         print("Job removed successfully")
+       
+#     except rest.ApiException as exception:
+#         response_data=json.loads(exception.body)
+#         raise exceptions.Py4HEAppEException(response_data['title'], response_data['detail'], response_data['status']) from None
+    
+#     except Exception as exception:
+#         raise exceptions.Py4HEAppEException("Link to a HEAppE instance is not set or valid. Please check Conf Init option.") from None  
+
+# @app.command(name="ListJobs")
+# def remove_job():
+#     """Remove HPC job"""
+#     try:
+#         print("Removing of HPC Job ...") 
+#         parameters = {
+#             "_preload_content": False,
+#             "SessionCode": utils.load_stored_session()
+#         }
+
+#         response= heappeCore.JobManagementApi(configuration.get_api_instance()).heappe_job_management_list_jobs_for_current_user_get(**parameters)
+#         print(json.dumps(response.data, indent = 3))
+       
+#     except rest.ApiException as exception:
+#         response_data=json.loads(exception.body)
+#         raise exceptions.Py4HEAppEException(response_data['title'], response_data['detail'], response_data['status']) from None
+    
+#     except Exception as exception:
+#         raise exceptions.Py4HEAppEException("Link to a HEAppE instance is not set or valid. Please check Conf Init option.") from None  
+
+# @app.command(name="ListJobs")
+# def remove_job(id:int = typer.Option(..., help='Created HPC Job Info Identifier')):
+#     """Remove HPC job"""
+#     try:
+#         print("Removing of HPC Job ...") 
+#         parameters = {
+#             "_preload_content": False,
+#             "CreatedJobInfoId": id,
+#             "SessionCode": utils.load_stored_session()
+#         }
+
+#         response = heappeCore.JobManagementApi(configuration.get_api_instance()).heappe_job_management_current_info_for_job_get(**parameters)
+#         print(json.dumps(response.data, indent = 3))
+       
+#     except rest.ApiException as exception:
+#         response_data=json.loads(exception.body)
+#         raise exceptions.Py4HEAppEException(response_data['title'], response_data['detail'], response_data['status']) from None
+    
+#     except Exception as exception:
+#         raise exceptions.Py4HEAppEException("Link to a HEAppE instance is not set or valid. Please check Conf Init option.") from None  
+
+
+# @app.command(name="CopyDataToTemp")
+# def copy_data_to_temp(id:int = typer.Option(..., help='Created HPC Job Info Identifier'),
+#                       path:str = typer.Option(..., help='Path containing data to be copied')):
+#     """Copy Data to Temporary location"""
+#     try:
+#         print("Copying HPC Job Data to Temporary location ...") 
+#         body = {
+#             "_preload_content": False,
+#             "CreatedJobInfoId": id,
+#             "Path": path,
+#             "SessionCode": utils.load_stored_session()
+#         }
+
+#         response = heappeCore.JobManagementApi(configuration.get_api_instance()).heappe_job_management_copy_job_data_to_temp_post(**body)
+#         print(f"Specific data was successfully copied to temporary location. Hash for usage the data is: {response.data}")
+       
+#     except rest.ApiException as exception:
+#         response_data=json.loads(exception.body)
+#         raise exceptions.Py4HEAppEException(response_data['title'], response_data['detail'], response_data['status']) from None
+    
+#     except Exception as exception:
+#         raise exceptions.Py4HEAppEException("Link to a HEAppE instance is not set or valid. Please check Conf Init option.") from None  
+
+# @app.command(name="CopyDataFromTemp")
+# def copy_data_from_temp(id:int = typer.Option(..., help='Created HPC Job Info Identifier'),
+#                         temporaryHash:str = typer.Option(..., help='Path containing data to be copied')):
+#     """Copy Data From Temporary location"""
+#     try:
+#         print("Copying HPC Job Data from Temporary location to Job Directory...") 
+#         body = {
+#             "_preload_content": False,
+#             "CreatedJobInfoId": id,
+#             "TempSessionCode": temporaryHash,
+#             "SessionCode": utils.load_stored_session()
+#         }
+
+#         response = heappeCore.JobManagementApi(configuration.get_api_instance()).heappe_job_management_copy_job_data_from_temp_post(**body)
+#         print(f"{response.data}")
+       
+#     except rest.ApiException as exception:
+#         response_data=json.loads(exception.body)
+#         raise exceptions.Py4HEAppEException(response_data['title'], response_data['detail'], response_data['status']) from None
+    
+#     except Exception as exception:
+#         raise exceptions.Py4HEAppEException("Link to a HEAppE instance is not set or valid. Please check Conf Init option.") from None  
+
+# @app.command(name="GetAllocatedNodes")
+# def get_allocated_nodes_ip(id:int = typer.Option(..., help='Created HPC Job Info Identifier')):
+#     """Get Allocated Nodes IP Addresses for the HPC Job"""
+#     try:
+#         print("Getting Allocated Nodes IP Addresses for the HPC Job ...") 
+#         parameters = {
+#             "_preload_content": False,
+#             "CreatedJobInfoId": id,
+#             "SessionCode": utils.load_stored_session()
+#         }
+
+#         response = heappeCore.JobManagementApi(configuration.get_api_instance()).heappe_job_management_allocated_nodes_ips_get(**parameters)
+#         print(f"HPC Job {id} uses the following nodes: {response.data}")
+       
+#     except rest.ApiException as exception:
+#         response_data=json.loads(exception.body)
+#         raise exceptions.Py4HEAppEException(response_data['title'], response_data['detail'], response_data['status']) from None
+    
+#     except Exception as exception:
+#         raise exceptions.Py4HEAppEException("Link to a HEAppE instance is not set or valid. Please check Conf Init option.") from None  
+    
+
+# if __name__ == '__main__':
+#     app()

py4heappe/cli/report.py

@@ -0,0 +1,173 @@
+import json
+import typer
+
+import py4heappe.cli.configuration as configuration
+import py4heappe.core.base.utils as utils
+import py4heappe.core as heappeCore
+
+from datetime import datetime
+from py4heappe.core.base import exceptions
+from py4heappe.core  import rest 
+
+
+app = typer.Typer(name="ReportCLI", no_args_is_help=True, pretty_exceptions_show_locals=False)
+
+@app.command(name="GroupList")
+def list_groups():
+    """List associated user groups"""
+    try:
+        utils.print_and_log("Listing groups where the user is assigned …") 
+        parameters = {
+            "_preload_content": False,
+            "SessionCode": utils.load_stored_session()
+        }
+
+        response = heappeCore.JobReportingApi(configuration.get_api_instance()).heappe_job_reporting_list_adaptor_user_groups_get(**parameters)
+        print(f"\nAssociated user groups:\n{json.dumps(json.loads(response.data), indent = 3)}")
+
+    except rest.ApiException as exception:
+        try:
+            response_data = json.loads(exception.body)
+            raise exceptions.Py4HEAppEAPIException(response_data['title'], response_data['detail'], response_data['status']) from None
+        except json.JSONDecodeError:
+            raise exceptions.Py4HEAppEException("Link to a HEAppE instance is not set or valid. Please check Conf Init option.") from None
+
+    except exceptions.Py4HEAppEAPIInternalException as exception:
+         raise exceptions.Py4HEAppEException(exception.message) from None
+
+    except exceptions.Py4HEAppEInternalException as exception:
+         raise exceptions.Py4HEAppEException(exception.message) from None 
+    
+    except Exception as exception:
+        raise exceptions.Py4HEAppEInternalException(f"Other exception: {str(exception)}") from None
+
+@app.command(name="UserUsage")
+def get_user_report(userId:int = typer.Option(..., help='Id (User)'),
+                    startDate:str = typer.Option(None, help='Start Date with time (Format: YYYY-MM-DDTHH:mm:ss)'),
+                    endDate:str = typer.Option(None, help='End Date with time (Format:YYYY-MM-DDTHH:mm:ss)')):
+    """Resource usage report for user"""
+    try:
+        utils.print_and_log("Fetching usage report for user …") 
+        parameters = {
+            "_preload_content": False,
+            "UserId": userId,
+            "StartTime": startDate if startDate is not None else "2000-01-01T00:00:00Z",
+            "EndTime": endDate if endDate is not None else datetime.now().strftime("%Y-%m-%dT%H:%M:%SZ"),
+            "SessionCode": utils.load_stored_session()
+        }
+
+        response = heappeCore.JobReportingApi(configuration.get_api_instance()).heappe_job_reporting_user_resource_usage_report_get(**parameters)
+        print(f"\nUser usage report:\n{json.dumps(json.loads(response.data), indent = 3)}")
+       
+    except rest.ApiException as exception:
+        try:
+            response_data = json.loads(exception.body)
+            raise exceptions.Py4HEAppEAPIException(response_data['title'], response_data['detail'], response_data['status']) from None
+        except json.JSONDecodeError:
+            raise exceptions.Py4HEAppEException("Link to a HEAppE instance is not set or valid. Please check Conf Init option.") from None
+
+    except exceptions.Py4HEAppEAPIInternalException as exception:
+         raise exceptions.Py4HEAppEException(exception.message) from None
+
+    except exceptions.Py4HEAppEInternalException as exception:
+         raise exceptions.Py4HEAppEException(exception.message) from None 
+    
+    except Exception as exception:
+        raise exceptions.Py4HEAppEInternalException(f"Other exception: {str(exception)}") from None
+
+@app.command(name="GroupUsage")
+def get_group_report(groupId:int = typer.Option(..., help='Id (User group)'),
+                     startDate:str = typer.Option(None, help='Start Date with time (Format: YYYY-MM-DDTHH:mm:ss)'),
+                     endDate:str = typer.Option(None, help='End Date with time (Format:YYYY-MM-DDTHH:mm:ss)')):
+    """Resource usage report for user group"""
+    try:
+        utils.print_and_log("Fetching usage report for user group …") 
+        parameters = {
+            "_preload_content": False,
+            "GroupId": groupId,
+            "StartTime": startDate if startDate is not None else "2000-01-01T00:00:00Z",
+            "EndTime": endDate if endDate is not None else datetime.now().strftime("%Y-%m-%dT%H:%M:%SZ"),
+            "SessionCode": utils.load_stored_session()
+        }
+
+        response = heappeCore.JobReportingApi(configuration.get_api_instance()).heappe_job_reporting_user_group_resource_usage_report_get(**parameters)
+        print(f"\nUser group usage report:\n{json.dumps(json.loads(response.data), indent = 3)}")
+       
+    except rest.ApiException as exception:
+        try:
+            response_data = json.loads(exception.body)
+            raise exceptions.Py4HEAppEAPIException(response_data['title'], response_data['detail'], response_data['status']) from None
+        except json.JSONDecodeError:
+            raise exceptions.Py4HEAppEException("Link to a HEAppE instance is not set or valid. Please check Conf Init option.") from None
+
+    except exceptions.Py4HEAppEAPIInternalException as exception:
+         raise exceptions.Py4HEAppEException(exception.message) from None
+
+    except exceptions.Py4HEAppEInternalException as exception:
+         raise exceptions.Py4HEAppEException(exception.message) from None 
+    
+    except Exception as exception:
+        raise exceptions.Py4HEAppEInternalException(f"Other exception: {str(exception)}") from None
+
+@app.command(name="GroupUsageDetailed")
+def get_detailed_jobs_report():
+    """Deailed resource usage report for user groups"""
+    try:
+        utils.print_and_log("Fetching detailed usage report for user groups …") 
+        parameters = {
+            "_preload_content": False,
+            "SessionCode": utils.load_stored_session()
+        }
+
+        response = heappeCore.JobReportingApi(configuration.get_api_instance()).heappe_job_reporting_jobs_detailed_report_get(**parameters)
+        print(f"\nDetailed user groups usage report:\n{json.dumps(json.loads(response.data), indent = 3)}")
+
+    except rest.ApiException as exception:
+        try:
+            response_data = json.loads(exception.body)
+            raise exceptions.Py4HEAppEAPIException(response_data['title'], response_data['detail'], response_data['status']) from None
+        except json.JSONDecodeError:
+            raise exceptions.Py4HEAppEException("Link to a HEAppE instance is not set or valid. Please check Conf Init option.") from None
+
+    except exceptions.Py4HEAppEAPIInternalException as exception:
+         raise exceptions.Py4HEAppEException(exception.message) from None
+
+    except exceptions.Py4HEAppEInternalException as exception:
+         raise exceptions.Py4HEAppEException(exception.message) from None 
+    
+    except Exception as exception:
+        raise exceptions.Py4HEAppEInternalException(f"Other exception: {str(exception)}") from None
+
+@app.command(name="JobUsage")
+def get_detailed_job_report(id:int = typer.Option(..., help='Id (Job)')):
+    """Resource usage report for job"""
+    try:
+        utils.print_and_log("Fetching job usage report …") 
+        parameters = {
+            "_preload_content": False,
+            "JobId": id,
+            "SessionCode": utils.load_stored_session()
+        }
+
+        response = heappeCore.JobReportingApi(configuration.get_api_instance()).heappe_job_reporting_resource_usage_report_for_job_get(**parameters)
+        print(f"\nJob usage report: \n{json.dumps(json.loads(response.data), indent = 3)}")
+
+    except rest.ApiException as exception:
+        try:
+            response_data = json.loads(exception.body)
+            raise exceptions.Py4HEAppEAPIException(response_data['title'], response_data['detail'], response_data['status']) from None
+        except json.JSONDecodeError:
+            raise exceptions.Py4HEAppEException("Link to a HEAppE instance is not set or valid. Please check Conf Init option.") from None
+
+    except exceptions.Py4HEAppEAPIInternalException as exception:
+         raise exceptions.Py4HEAppEException(exception.message) from None
+
+    except exceptions.Py4HEAppEInternalException as exception:
+         raise exceptions.Py4HEAppEException(exception.message) from None 
+    
+    except Exception as exception:
+        raise exceptions.Py4HEAppEInternalException(f"Other exception: {str(exception)}") from None
+
+
+if __name__ == '__main__':
+    app()