Py4HEAppE 1.0.0__py3-none-any.whl

py4heappe/core/base/utils.py

@@ -0,0 +1,43 @@
+import os
+import platform
+import subprocess
+
+from py4heappe.core.base import exceptions
+from py4heappe.core.base.logger import logger
+
+def print_and_log(message: str):
+    print(message)
+    logger.info(message)
+
+def get_user_shell_for_platform():
+    current_platform=platform.system()
+    if current_platform == "Linux" or current_platform == "Darwin":
+        # Use bash for Linux and macOS (Darwin is the name for macOS)
+        return "bash"
+    elif current_platform == "Windows":
+        return "powershell"
+    else:
+        raise exceptions.Py4HEAppEInternalException(f"Unsupported platform: {current_platform}") from None
+
+def store_session(sessionCode: str):
+    try:
+        if sessionCode is None:
+            raise exceptions.Py4HEAppEInternalException("Problem occurs with authentication to HEAppE instance.") from None
+    
+        environment_snapshot: dict = os.environ
+        environment_snapshot.update({"sessionCode": sessionCode}) 
+        subprocess.call(get_user_shell_for_platform(), env=environment_snapshot)
+
+    except exceptions.Py4HEAppEInternalException as exception:
+         raise exceptions.Py4HEAppEInternalException(exception.message) from None
+
+    except Exception:
+        raise exceptions.Py4HEAppEInternalException("Problem occurs during storing HEAppE sessionCode into variable.") from None
+    
+def load_stored_session():
+    sessionCode: str = os.environ.get("sessionCode")
+
+    if sessionCode is None:
+        raise exceptions.Py4HEAppEInternalException("Session for HEAppE instance does not exist! You have to authenticate to HEAppE instance.") from None
+    
+    return sessionCode

py4heappe/core/configuration.py

@@ -0,0 +1,247 @@
+# coding: utf-8
+
+"""
+    HEAppE Web API
+
+    HEAppE middleware API v4.2.1  # noqa: E501
+
+    OpenAPI spec version: v4.2.1
+    Contact: support.heappe@it4i.cz
+    Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+from __future__ import absolute_import
+
+import copy
+import logging
+import multiprocessing
+import sys
+import urllib3
+
+import six
+from six.moves import http_client as httplib
+
+
+class TypeWithDefault(type):
+    def __init__(cls, name, bases, dct):
+        super(TypeWithDefault, cls).__init__(name, bases, dct)
+        cls._default = None
+
+    def __call__(cls):
+        if cls._default is None:
+            cls._default = type.__call__(cls)
+        return copy.copy(cls._default)
+
+    def set_default(cls, default):
+        cls._default = copy.copy(default)
+
+
+class Configuration(six.with_metaclass(TypeWithDefault, object)):
+    """NOTE: This class is auto generated by the swagger code generator program.
+
+    Ref: https://github.com/swagger-api/swagger-codegen
+    Do not edit the class manually.
+    """
+
+    def __init__(self):
+        """Constructor"""
+        # Default Base url
+        self.host = "https://heappe.it4i.cz/development"
+        # Temp file folder for downloading files
+        self.temp_folder_path = None
+
+        # Authentication Settings
+        # dict to store API key(s)
+        self.api_key = {}
+        # dict to store API prefix (e.g. Bearer)
+        self.api_key_prefix = {}
+        # function to refresh API key if expired
+        self.refresh_api_key_hook = None
+        # Username for HTTP basic authentication
+        self.username = ""
+        # Password for HTTP basic authentication
+        self.password = ""
+        # Logging Settings
+        self.logger = {}
+        self.logger["package_logger"] = logging.getLogger("heappeac_v4")
+        self.logger["urllib3_logger"] = logging.getLogger("urllib3")
+        # Log format
+        self.logger_format = '%(asctime)s %(levelname)s %(message)s'
+        # Log stream handler
+        self.logger_stream_handler = None
+        # Log file handler
+        self.logger_file_handler = None
+        # Debug file location
+        self.logger_file = None
+        # Debug switch
+        self.debug = False
+
+        # SSL/TLS verification
+        # Set this to false to skip verifying SSL certificate when calling API
+        # from https server.
+        self.verify_ssl = True
+        # Set this to customize the certificate file to verify the peer.
+        self.ssl_ca_cert = None
+        # client certificate file
+        self.cert_file = None
+        # client key file
+        self.key_file = None
+        # Set this to True/False to enable/disable SSL hostname verification.
+        self.assert_hostname = None
+
+        # urllib3 connection pool's maximum number of connections saved
+        # per pool. urllib3 uses 1 connection as default value, but this is
+        # not the best value when you are making a lot of possibly parallel
+        # requests to the same host, which is often the case here.
+        # cpu_count * 5 is used as default value to increase performance.
+        self.connection_pool_maxsize = multiprocessing.cpu_count() * 5
+
+        # Proxy URL
+        self.proxy = None
+        # Safe chars for path_param
+        self.safe_chars_for_path_param = ''
+
+    @property
+    def logger_file(self):
+        """The logger file.
+
+        If the logger_file is None, then add stream handler and remove file
+        handler. Otherwise, add file handler and remove stream handler.
+
+        :param value: The logger_file path.
+        :type: str
+        """
+        return self.__logger_file
+
+    @logger_file.setter
+    def logger_file(self, value):
+        """The logger file.
+
+        If the logger_file is None, then add stream handler and remove file
+        handler. Otherwise, add file handler and remove stream handler.
+
+        :param value: The logger_file path.
+        :type: str
+        """
+        self.__logger_file = value
+        if self.__logger_file:
+            # If set logging file,
+            # then add file handler and remove stream handler.
+            self.logger_file_handler = logging.FileHandler(self.__logger_file)
+            self.logger_file_handler.setFormatter(self.logger_formatter)
+            for _, logger in six.iteritems(self.logger):
+                logger.addHandler(self.logger_file_handler)
+                if self.logger_stream_handler:
+                    logger.removeHandler(self.logger_stream_handler)
+        else:
+            # If not set logging file,
+            # then add stream handler and remove file handler.
+            self.logger_stream_handler = logging.StreamHandler()
+            self.logger_stream_handler.setFormatter(self.logger_formatter)
+            for _, logger in six.iteritems(self.logger):
+                logger.addHandler(self.logger_stream_handler)
+                if self.logger_file_handler:
+                    logger.removeHandler(self.logger_file_handler)
+
+    @property
+    def debug(self):
+        """Debug status
+
+        :param value: The debug status, True or False.
+        :type: bool
+        """
+        return self.__debug
+
+    @debug.setter
+    def debug(self, value):
+        """Debug status
+
+        :param value: The debug status, True or False.
+        :type: bool
+        """
+        self.__debug = value
+        if self.__debug:
+            # if debug status is True, turn on debug logging
+            for _, logger in six.iteritems(self.logger):
+                logger.setLevel(logging.DEBUG)
+            # turn on httplib debug
+            httplib.HTTPConnection.debuglevel = 1
+        else:
+            # if debug status is False, turn off debug logging,
+            # setting log level to default `logging.WARNING`
+            for _, logger in six.iteritems(self.logger):
+                logger.setLevel(logging.WARNING)
+            # turn off httplib debug
+            httplib.HTTPConnection.debuglevel = 0
+
+    @property
+    def logger_format(self):
+        """The logger format.
+
+        The logger_formatter will be updated when sets logger_format.
+
+        :param value: The format string.
+        :type: str
+        """
+        return self.__logger_format
+
+    @logger_format.setter
+    def logger_format(self, value):
+        """The logger format.
+
+        The logger_formatter will be updated when sets logger_format.
+
+        :param value: The format string.
+        :type: str
+        """
+        self.__logger_format = value
+        self.logger_formatter = logging.Formatter(self.__logger_format)
+
+    def get_api_key_with_prefix(self, identifier):
+        """Gets API key (with prefix if set).
+
+        :param identifier: The identifier of apiKey.
+        :return: The token for api key authentication.
+        """
+        if self.refresh_api_key_hook:
+            self.refresh_api_key_hook(self)
+
+        key = self.api_key.get(identifier)
+        if key:
+            prefix = self.api_key_prefix.get(identifier)
+            if prefix:
+                return "%s %s" % (prefix, key)
+            else:
+                return key
+
+    def get_basic_auth_token(self):
+        """Gets HTTP basic authentication header (string).
+
+        :return: The token for basic HTTP authentication.
+        """
+        token = ""
+        if self.username or self.password:
+            token = urllib3.util.make_headers(
+                basic_auth=self.username + ':' + self.password
+            ).get('authorization')
+        return token
+
+    def auth_settings(self):
+        """Gets Auth Settings dict for api client.
+
+        :return: The Auth Settings information dict.
+        """
+        return {
+        }
+
+    def to_debug_report(self):
+        """Gets the essential information for debugging.
+
+        :return: The report for debugging.
+        """
+        return "Python SDK Debug Report:\n"\
+               "OS: {env}\n"\
+               "Python Version: {pyversion}\n"\
+               "Version of the API: v4.2.1\n"\
+               "SDK Package Version: 1.0.0".\
+               format(env=sys.platform, pyversion=sys.version)

py4heappe/core/models/__init__.py

@@ -0,0 +1,155 @@
+# coding: utf-8
+
+# flake8: noqa
+"""
+    HEAppE Web API
+
+    HEAppE middleware API v4.2.1  # noqa: E501
+
+    OpenAPI spec version: v4.2.1
+    Contact: support.heappe@it4i.cz
+    Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+from __future__ import absolute_import
+
+# import models into model package
+from py4heappe.core.models.adaptor_user import AdaptorUser
+from py4heappe.core.models.adaptor_user_group import AdaptorUserGroup
+from py4heappe.core.models.adaptor_user_role import AdaptorUserRole
+from py4heappe.core.models.adaptor_user_role_ext import AdaptorUserRoleExt
+from py4heappe.core.models.adaptor_user_role_type import AdaptorUserRoleType
+from py4heappe.core.models.adaptor_user_type import AdaptorUserType
+from py4heappe.core.models.adaptor_user_user_group_role import AdaptorUserUserGroupRole
+from py4heappe.core.models.authenticate_lexis_token_model import AuthenticateLexisTokenModel
+from py4heappe.core.models.authenticate_user_digital_signature_model import AuthenticateUserDigitalSignatureModel
+from py4heappe.core.models.authenticate_user_open_id_model import AuthenticateUserOpenIdModel
+from py4heappe.core.models.authenticate_user_open_id_open_stack_model import AuthenticateUserOpenIdOpenStackModel
+from py4heappe.core.models.authenticate_user_password_model import AuthenticateUserPasswordModel
+from py4heappe.core.models.authentication_credentials import AuthenticationCredentials
+from py4heappe.core.models.bad_request_result import BadRequestResult
+from py4heappe.core.models.cancel_job_model import CancelJobModel
+from py4heappe.core.models.cluster import Cluster
+from py4heappe.core.models.cluster_authentication_credentials import ClusterAuthenticationCredentials
+from py4heappe.core.models.cluster_authentication_credentials_auth_type import ClusterAuthenticationCredentialsAuthType
+from py4heappe.core.models.cluster_connection_protocol import ClusterConnectionProtocol
+from py4heappe.core.models.cluster_detailed_report_ext import ClusterDetailedReportExt
+from py4heappe.core.models.cluster_ext import ClusterExt
+from py4heappe.core.models.cluster_init_report_ext import ClusterInitReportExt
+from py4heappe.core.models.cluster_node_type import ClusterNodeType
+from py4heappe.core.models.cluster_node_type_detailed_report_ext import ClusterNodeTypeDetailedReportExt
+from py4heappe.core.models.cluster_node_type_ext import ClusterNodeTypeExt
+from py4heappe.core.models.cluster_node_type_for_task_ext import ClusterNodeTypeForTaskExt
+from py4heappe.core.models.cluster_node_type_report_ext import ClusterNodeTypeReportExt
+from py4heappe.core.models.cluster_node_type_requested_group import ClusterNodeTypeRequestedGroup
+from py4heappe.core.models.cluster_node_type_resource_usage_ext import ClusterNodeTypeResourceUsageExt
+from py4heappe.core.models.cluster_node_usage_ext import ClusterNodeUsageExt
+from py4heappe.core.models.cluster_project import ClusterProject
+from py4heappe.core.models.cluster_project_credential import ClusterProjectCredential
+from py4heappe.core.models.cluster_proxy_connection import ClusterProxyConnection
+from py4heappe.core.models.cluster_proxy_connection_ext import ClusterProxyConnectionExt
+from py4heappe.core.models.cluster_report_ext import ClusterReportExt
+from py4heappe.core.models.command_template import CommandTemplate
+from py4heappe.core.models.command_template_ext import CommandTemplateExt
+from py4heappe.core.models.command_template_parameter import CommandTemplateParameter
+from py4heappe.core.models.command_template_parameter_ext import CommandTemplateParameterExt
+from py4heappe.core.models.command_template_parameter_value_ext import CommandTemplateParameterValueExt
+from py4heappe.core.models.contact import Contact
+from py4heappe.core.models.copy_job_data_from_temp_model import CopyJobDataFromTempModel
+from py4heappe.core.models.copy_job_data_to_temp_model import CopyJobDataToTempModel
+from py4heappe.core.models.create_command_inner_template_parameter_model import CreateCommandInnerTemplateParameterModel
+from py4heappe.core.models.create_command_template_from_generic_model import CreateCommandTemplateFromGenericModel
+from py4heappe.core.models.create_command_template_model import CreateCommandTemplateModel
+from py4heappe.core.models.create_command_template_parameter_model import CreateCommandTemplateParameterModel
+from py4heappe.core.models.create_job_by_project_model import CreateJobByProjectModel
+from py4heappe.core.models.create_project_assignment_to_cluster_model import CreateProjectAssignmentToClusterModel
+from py4heappe.core.models.create_project_model import CreateProjectModel
+from py4heappe.core.models.create_secure_shell_key_model import CreateSecureShellKeyModel
+from py4heappe.core.models.create_secure_shell_key_model_obsolete import CreateSecureShellKeyModelObsolete
+from py4heappe.core.models.data_transfer_method_ext import DataTransferMethodExt
+from py4heappe.core.models.delete_job_model import DeleteJobModel
+from py4heappe.core.models.deployment_type_ext import DeploymentTypeExt
+from py4heappe.core.models.digital_signature_credentials_ext import DigitalSignatureCredentialsExt
+from py4heappe.core.models.download_file_from_cluster_model import DownloadFileFromClusterModel
+from py4heappe.core.models.download_parts_of_job_files_from_cluster_model import DownloadPartsOfJobFilesFromClusterModel
+from py4heappe.core.models.end_data_transfer_model import EndDataTransferModel
+from py4heappe.core.models.end_file_transfer_model import EndFileTransferModel
+from py4heappe.core.models.environment_variable_ext import EnvironmentVariableExt
+from py4heappe.core.models.extended_command_template_ext import ExtendedCommandTemplateExt
+from py4heappe.core.models.extended_command_template_parameter_ext import ExtendedCommandTemplateParameterExt
+from py4heappe.core.models.extended_project_info_ext import ExtendedProjectInfoExt
+from py4heappe.core.models.file_information_ext import FileInformationExt
+from py4heappe.core.models.file_transfer_cipher_type import FileTransferCipherType
+from py4heappe.core.models.file_transfer_cipher_type_ext import FileTransferCipherTypeExt
+from py4heappe.core.models.file_transfer_key_credentials_ext import FileTransferKeyCredentialsExt
+from py4heappe.core.models.file_transfer_method import FileTransferMethod
+from py4heappe.core.models.file_transfer_method_ext import FileTransferMethodExt
+from py4heappe.core.models.file_transfer_protocol import FileTransferProtocol
+from py4heappe.core.models.file_transfer_protocol_ext import FileTransferProtocolExt
+from py4heappe.core.models.get_command_template_parameters_name_model import GetCommandTemplateParametersNameModel
+from py4heappe.core.models.get_data_transfer_method_model import GetDataTransferMethodModel
+from py4heappe.core.models.get_file_transfer_method_model import GetFileTransferMethodModel
+from py4heappe.core.models.http_header_ext import HTTPHeaderExt
+from py4heappe.core.models.http_get_to_job_node_model import HttpGetToJobNodeModel
+from py4heappe.core.models.http_post_to_job_node_model import HttpPostToJobNodeModel
+from py4heappe.core.models.initialize_cluster_script_directory_model import InitializeClusterScriptDirectoryModel
+from py4heappe.core.models.instance_information_ext import InstanceInformationExt
+from py4heappe.core.models.job_detailed_report_ext import JobDetailedReportExt
+from py4heappe.core.models.job_file_content_ext import JobFileContentExt
+from py4heappe.core.models.job_report_ext import JobReportExt
+from py4heappe.core.models.job_specification_ext import JobSpecificationExt
+from py4heappe.core.models.job_state_aggregation_report_ext import JobStateAggregationReportExt
+from py4heappe.core.models.job_state_ext import JobStateExt
+from py4heappe.core.models.lexis_credentials_ext import LexisCredentialsExt
+from py4heappe.core.models.modify_command_template_from_generic_model import ModifyCommandTemplateFromGenericModel
+from py4heappe.core.models.modify_command_template_model import ModifyCommandTemplateModel
+from py4heappe.core.models.modify_command_template_parameter_model import ModifyCommandTemplateParameterModel
+from py4heappe.core.models.modify_project_assignment_to_cluster_model import ModifyProjectAssignmentToClusterModel
+from py4heappe.core.models.modify_project_model import ModifyProjectModel
+from py4heappe.core.models.node_used_cores_and_limitation_ext import NodeUsedCoresAndLimitationExt
+from py4heappe.core.models.open_id_credentials_ext import OpenIdCredentialsExt
+from py4heappe.core.models.open_stack_application_credentials_ext import OpenStackApplicationCredentialsExt
+from py4heappe.core.models.password_credentials_ext import PasswordCredentialsExt
+from py4heappe.core.models.problem_details import ProblemDetails
+from py4heappe.core.models.project import Project
+from py4heappe.core.models.project_contact import ProjectContact
+from py4heappe.core.models.project_detailed_report_ext import ProjectDetailedReportExt
+from py4heappe.core.models.project_ext import ProjectExt
+from py4heappe.core.models.project_for_task_ext import ProjectForTaskExt
+from py4heappe.core.models.project_list_report_ext import ProjectListReportExt
+from py4heappe.core.models.project_reference_ext import ProjectReferenceExt
+from py4heappe.core.models.project_report_ext import ProjectReportExt
+from py4heappe.core.models.project_resource_usage_ext import ProjectResourceUsageExt
+from py4heappe.core.models.proxy_type import ProxyType
+from py4heappe.core.models.proxy_type_ext import ProxyTypeExt
+from py4heappe.core.models.public_key_ext import PublicKeyExt
+from py4heappe.core.models.regenerate_secure_shell_key_model import RegenerateSecureShellKeyModel
+from py4heappe.core.models.regenerate_secure_shell_key_model_obsolete import RegenerateSecureShellKeyModelObsolete
+from py4heappe.core.models.remove_command_template_model import RemoveCommandTemplateModel
+from py4heappe.core.models.remove_command_template_parameter_model import RemoveCommandTemplateParameterModel
+from py4heappe.core.models.remove_project_assignment_to_cluster_model import RemoveProjectAssignmentToClusterModel
+from py4heappe.core.models.remove_project_model import RemoveProjectModel
+from py4heappe.core.models.remove_secure_shell_key_model import RemoveSecureShellKeyModel
+from py4heappe.core.models.remove_secure_shell_key_model_obsolete import RemoveSecureShellKeyModelObsolete
+from py4heappe.core.models.resource_allocation_type_ext import ResourceAllocationTypeExt
+from py4heappe.core.models.scheduler_type import SchedulerType
+from py4heappe.core.models.ssh_key_user_credentials_model import SshKeyUserCredentialsModel
+from py4heappe.core.models.submit_job_model import SubmitJobModel
+from py4heappe.core.models.submitted_job_info_ext import SubmittedJobInfoExt
+from py4heappe.core.models.submitted_task_info_ext import SubmittedTaskInfoExt
+from py4heappe.core.models.synchronizable_files_ext import SynchronizableFilesExt
+from py4heappe.core.models.task_detailed_report_ext import TaskDetailedReportExt
+from py4heappe.core.models.task_file_offset_ext import TaskFileOffsetExt
+from py4heappe.core.models.task_paralization_parameter_ext import TaskParalizationParameterExt
+from py4heappe.core.models.task_priority_ext import TaskPriorityExt
+from py4heappe.core.models.task_report_ext import TaskReportExt
+from py4heappe.core.models.task_specification_ext import TaskSpecificationExt
+from py4heappe.core.models.task_state_ext import TaskStateExt
+from py4heappe.core.models.test_cluster_access_for_account_model_obsolete import TestClusterAccessForAccountModelObsolete
+from py4heappe.core.models.unauthorized_result import UnauthorizedResult
+from py4heappe.core.models.usage_type import UsageType
+from py4heappe.core.models.usage_type_ext import UsageTypeExt
+from py4heappe.core.models.user_group_detailed_report_ext import UserGroupDetailedReportExt
+from py4heappe.core.models.user_group_list_report_ext import UserGroupListReportExt
+from py4heappe.core.models.user_group_report_ext import UserGroupReportExt
+from py4heappe.core.models.version_information_ext import VersionInformationExt