dtlpy 1.114.17__py3-none-any.whl → 1.116.6__py3-none-any.whl

dtlpy/entities/execution.py

@@ -1,397 +1,397 @@
-import attr
-import logging
-import traceback
-from enum import Enum
-from collections import namedtuple
-
-from .. import repositories, entities
-from ..services.api_client import ApiClient
-
-logger = logging.getLogger(name='dtlpy')
-
-
-class ExecutionStatus(str, Enum):
-    SUCCESS = "success"
-    FAILED = "failed"
-    IN_PROGRESS = "in-progress"
-    CREATED = "created"
-    TERMINATED = 'terminated',
-    ABORTED = 'aborted'
-    CANCELED = 'canceled'
-    SYSTEM_FAILURE = 'system-failure'
-
-
-@attr.s
-class Execution(entities.BaseEntity):
-    """
-    Service execution entity
-    """
-    # platform
-    id = attr.ib()
-    url = attr.ib(repr=False)
-    creator = attr.ib()
-    created_at = attr.ib()
-    updated_at = attr.ib(repr=False)
-    input = attr.ib()
-    output = attr.ib(repr=False)
-    feedback_queue = attr.ib(repr=False)
-    _status = attr.ib(repr=False)
-    status_log = attr.ib(repr=False)
-    sync_reply_to = attr.ib(repr=False)
-    latest_status = attr.ib()
-    function_name = attr.ib()
-    duration = attr.ib()
-    attempts = attr.ib()
-    max_attempts = attr.ib()
-    to_terminate = attr.ib(type=bool)
-
-    # name changed
-    trigger_id = attr.ib()
-    service_id = attr.ib()
-    project_id = attr.ib()
-    service_version = attr.ib()
-    package_id = attr.ib()
-    package_name = attr.ib()
-    package_revision = attr.ib()
-
-    # sdk
-    _client_api = attr.ib(type=ApiClient, repr=False)
-    _service = attr.ib(repr=False)
-    _project = attr.ib(repr=False, default=None)
-    _repositories = attr.ib(repr=False)
-
-    # optional
-    pipeline = attr.ib(type=dict, default=None, repr=False)
-    model = attr.ib(type=dict, default=None, repr=False)
-    app = attr.ib(default=None)
-    driver_id = attr.ib(default=None)
-
-    ################
-    # repositories #
-    ################
-    @_repositories.default
-    def set_repositories(self):
-        reps = namedtuple('repositories',
-                          field_names=['executions', 'services'])
-
-        if self._project is not None:
-            services_repo = self._project.services
-            executions_repo = self._project.executions
-        elif self._service is not None:
-            services_repo = self._service.services
-            executions_repo = self._service.executions
-        else:
-            services_repo = repositories.Services(client_api=self._client_api,
-                                                  project=self._project,
-                                                  package=None)
-            executions_repo = repositories.Executions(client_api=self._client_api,
-                                                      project=self._project,
-                                                      service=self._service)
-
-        r = reps(executions=executions_repo,
-                 services=services_repo)
-        return r
-
-    @property
-    def createdAt(self):
-        return self.created_at
-
-    @property
-    def updatedAt(self):
-        return self.updated_at
-
-    @property
-    def syncReplyTo(self):
-        return self.sync_reply_to
-
-    @property
-    def feedbackQueue(self):
-        return self.feedback_queue
-
-    @property
-    def status(self):
-        return self._status
-
-    @property
-    def services(self):
-        assert isinstance(self._repositories.services, repositories.Services)
-        return self._repositories.services
-
-    @property
-    def executions(self):
-        assert isinstance(self._repositories.executions, repositories.Executions)
-        return self._repositories.executions
-
-    @staticmethod
-    def _protected_from_json(_json, client_api, project=None, service=None, is_fetched=True):
-        """
-        Same as from_json but with try-except to catch if error
-        :param _json: platform json
-        :param client_api: ApiClient entity
-        :return:
-        """
-        try:
-            execution = Execution.from_json(_json=_json,
-                                            client_api=client_api,
-                                            project=None,
-                                            service=service,
-                                            is_fetched=is_fetched)
-            status = True
-        except Exception:
-            execution = traceback.format_exc()
-            status = False
-        return status, execution
-
-    @classmethod
-    def from_json(cls, _json, client_api, project=None, service=None, is_fetched=True):
-        """
-        :param dict _json: platform json
-        :param dl.ApiClient client_api: ApiClient entity
-        :param dtlpy.entities.project.Project project: project entity
-        :param dtlpy.entities.service.Service service:
-        :param is_fetched: is Entity fetched from Platform
-        """
-        if project is not None:
-            if project.id != _json.get('projectId', None):
-                logger.warning('Execution has been fetched from a project that is not belong to it')
-                project = None
-
-        if service is not None:
-            if service.id != _json.get('serviceId', None):
-                logger.warning('Execution has been fetched from a service that is not belong to it')
-                service = None
-
-        inst = cls(
-            feedback_queue=_json.get('feedbackQueue', None),
-            service_id=_json.get('serviceId', None),
-            project_id=_json.get('projectId', None),
-            latest_status=_json.get('latestStatus', None),
-            sync_reply_to=_json.get('syncReplyTo', None),
-            created_at=_json.get('createdAt', None),
-            updated_at=_json.get('updatedAt', None),
-            creator=_json.get('creator', None),
-            trigger_id=_json.get('triggerId', None),
-            attempts=_json.get('attempts', None),
-            max_attempts=_json.get('maxAttempts', None),
-            output=_json.get('output', None),
-            status=_json.get('status', None),
-            status_log=_json.get('statusLog', None),
-            duration=_json.get('duration', None),
-            function_name=_json.get('functionName', entities.package_defaults.DEFAULT_PACKAGE_FUNCTION_NAME),
-            input=_json.get('input', None),
-            url=_json.get('url', None),
-            id=_json.get('id', None),
-            to_terminate=_json.get('toTerminate', False),
-            client_api=client_api,
-            project=project,
-            service=service,
-            service_version=_json.get('serviceVersion', False),
-            package_id=_json.get('packageId', None),
-            package_name=_json.get('packageName', None),
-            pipeline=_json.get('pipeline', None),
-            model=_json.get('model', None),
-            package_revision=_json.get('packageRevision', None),
-            app=_json.get('app', None),
-            driver_id=_json.get('driverId', None)
-        )
-        inst.is_fetched = is_fetched
-        return inst
-
-    def to_json(self):
-        """
-        Returns platform _json format of object
-
-        :return: platform json format of object
-        :rtype: dict
-        """
-        # get excluded
-        _json = attr.asdict(
-            self, filter=attr.filters.exclude(
-                attr.fields(Execution)._client_api,
-                attr.fields(Execution)._service,
-                attr.fields(Execution)._project,
-                attr.fields(Execution).to_terminate,
-                attr.fields(Execution)._repositories,
-                attr.fields(Execution).project_id,
-                attr.fields(Execution).service_id,
-                attr.fields(Execution).trigger_id,
-                attr.fields(Execution).function_name,
-                attr.fields(Execution).max_attempts,
-                attr.fields(Execution).latest_status,
-                attr.fields(Execution).service_version,
-                attr.fields(Execution).package_id,
-                attr.fields(Execution).package_name,
-                attr.fields(Execution).status_log,
-                attr.fields(Execution)._status,
-                attr.fields(Execution).created_at,
-                attr.fields(Execution).updated_at,
-                attr.fields(Execution).feedback_queue,
-                attr.fields(Execution).sync_reply_to,
-                attr.fields(Execution).pipeline,
-                attr.fields(Execution).model,
-                attr.fields(Execution).package_revision,
-                attr.fields(Execution).driver_id,
-            )
-        )
-
-        # rename
-        _json['projectId'] = self.project_id
-        _json['triggerId'] = self.trigger_id
-        _json['serviceId'] = self.service_id
-        _json['functionName'] = self.function_name
-        _json['latestStatus'] = self.latest_status
-        _json['maxAttempts'] = self.max_attempts
-        _json['toTerminate'] = self.to_terminate
-        _json['serviceVersion'] = self.service_version
-        _json['packageId'] = self.package_id
-        _json['packageName'] = self.package_name
-        _json['statusLog'] = self.status_log
-        _json['status'] = self._status
-        _json['createdAt'] = self.created_at
-        _json['updatedAt'] = self.updated_at
-        _json['feedbackQueue'] = self.feedback_queue
-        _json['syncReplyTo '] = self.sync_reply_to
-        _json['packageRevision'] = self.package_revision
-        _json['driverId'] = self.driver_id
-
-        if self.pipeline:
-            _json['pipeline'] = self.pipeline
-        if self.model:
-            _json['model'] = self.model
-
-        return _json
-
-    @property
-    def pipeline_id(self) -> str:
-        pipeline_id = None
-        if self.pipeline:
-            pipeline_id = self.pipeline.get('id', None)
-        return pipeline_id
-
-    @property
-    def node_id(self) -> str:
-        node_id = None
-        if self.pipeline:
-            node_id = self.pipeline.get('nodeId', None)
-        return node_id
-
-    @property
-    def pipeline_execution_id(self) -> str:
-        pipeline_execution_id = None
-        if self.pipeline:
-            pipeline_execution_id = self.pipeline.get('executionId', None)
-        return pipeline_execution_id
-
-    @property
-    def service(self):
-        if self._service is None:
-            self._service = self.services.get(service_id=self.service_id, fetch=None)
-        assert isinstance(self._service, entities.Service)
-        return self._service
-
-    @property
-    def project(self):
-        if self._project is None:
-            self._project = repositories.Projects(client_api=self._client_api).get(project_id=self.project_id,
-                                                                                   fetch=None)
-        assert isinstance(self._project, entities.Project)
-        return self._project
-
-    def get_latest_status(self):
-        self.latest_status = self.executions.get(execution_id=self.id).latest_status
-        return self.latest_status
-
-    @service.setter
-    def service(self, service):
-        if not isinstance(service, entities.Service):
-            raise ValueError('Must input a valid service entity')
-        self._service = service
-
-    def progress_update(
-            self,
-            status: ExecutionStatus = None,
-            percent_complete: int = None,
-            message: str = None,
-            output: str = None,
-            service_version: str = None
-    ):
-        """
-        Update Execution Progress
-
-        :param str status: ExecutionStatus
-        :param int percent_complete: percent complete
-        :param str message: message to update the progress state
-        :param str output: output
-        :param str service_version: service version
-        :return: Service execution object
-        """
-        return self.executions.progress_update(
-            execution_id=self.id,
-            status=status,
-            percent_complete=percent_complete,
-            message=message,
-            output=output,
-            service_version=service_version
-        )
-
-    def update(self):
-        """
-        Update execution changes to platform
-
-        :return: execution entity
-        """
-        return self.executions.update(execution=self)
-
-    def logs(self, follow=False, log_level='DEBUG'):
-        """
-        Print logs for execution
-
-        :param follow: keep stream future logs
-        :param str log_level: the log level to display
-        """
-        self.services.log(execution_id=self.id,
-                          view=True,
-                          service=self.service,
-                          follow=follow,
-                          start=self.created_at,
-                          log_level=log_level)
-
-    def increment(self):
-        """
-        Increment attempts
-
-        :return:
-        """
-        self.attempts = self.executions.increment(execution=self)
-
-    def rerun(self, sync: bool = False):
-        """
-        Re-run
-
-        :return: Execution object
-        """
-        return self.executions.rerun(execution=self, sync=sync)
-
-    def terminate(self):
-        """
-        Terminate execution
-
-        :return: execution object
-        """
-        return self.executions.terminate(execution=self)
-
-    def wait(self):
-        """
-        Wait for execution
-
-        :return: Service execution object
-        """
-        return self.executions.wait(execution_id=self.id)
-
-    def in_progress(self):
-        return self.latest_status['status'] not in [ExecutionStatus.FAILED,
-                                                    ExecutionStatus.SUCCESS,
-                                                    ExecutionStatus.TERMINATED,
-                                                    ExecutionStatus.ABORTED,
-                                                    ExecutionStatus.CANCELED,
-                                                    ExecutionStatus.SYSTEM_FAILURE]
+import attr
+import logging
+import traceback
+from enum import Enum
+from collections import namedtuple
+
+from .. import repositories, entities
+from ..services.api_client import ApiClient
+
+logger = logging.getLogger(name='dtlpy')
+
+
+class ExecutionStatus(str, Enum):
+    SUCCESS = "success"
+    FAILED = "failed"
+    IN_PROGRESS = "in-progress"
+    CREATED = "created"
+    TERMINATED = 'terminated',
+    ABORTED = 'aborted'
+    CANCELED = 'canceled'
+    SYSTEM_FAILURE = 'system-failure'
+
+
+@attr.s
+class Execution(entities.BaseEntity):
+    """
+    Service execution entity
+    """
+    # platform
+    id = attr.ib()
+    url = attr.ib(repr=False)
+    creator = attr.ib()
+    created_at = attr.ib()
+    updated_at = attr.ib(repr=False)
+    input = attr.ib()
+    output = attr.ib(repr=False)
+    feedback_queue = attr.ib(repr=False)
+    _status = attr.ib(repr=False)
+    status_log = attr.ib(repr=False)
+    sync_reply_to = attr.ib(repr=False)
+    latest_status = attr.ib()
+    function_name = attr.ib()
+    duration = attr.ib()
+    attempts = attr.ib()
+    max_attempts = attr.ib()
+    to_terminate = attr.ib(type=bool)
+
+    # name changed
+    trigger_id = attr.ib()
+    service_id = attr.ib()
+    project_id = attr.ib()
+    service_version = attr.ib()
+    package_id = attr.ib()
+    package_name = attr.ib()
+    package_revision = attr.ib()
+
+    # sdk
+    _client_api = attr.ib(type=ApiClient, repr=False)
+    _service = attr.ib(repr=False)
+    _project = attr.ib(repr=False, default=None)
+    _repositories = attr.ib(repr=False)
+
+    # optional
+    pipeline = attr.ib(type=dict, default=None, repr=False)
+    model = attr.ib(type=dict, default=None, repr=False)
+    app = attr.ib(default=None)
+    driver_id = attr.ib(default=None)
+
+    ################
+    # repositories #
+    ################
+    @_repositories.default
+    def set_repositories(self):
+        reps = namedtuple('repositories',
+                          field_names=['executions', 'services'])
+
+        if self._project is not None:
+            services_repo = self._project.services
+            executions_repo = self._project.executions
+        elif self._service is not None:
+            services_repo = self._service.services
+            executions_repo = self._service.executions
+        else:
+            services_repo = repositories.Services(client_api=self._client_api,
+                                                  project=self._project,
+                                                  package=None)
+            executions_repo = repositories.Executions(client_api=self._client_api,
+                                                      project=self._project,
+                                                      service=self._service)
+
+        r = reps(executions=executions_repo,
+                 services=services_repo)
+        return r
+
+    @property
+    def createdAt(self):
+        return self.created_at
+
+    @property
+    def updatedAt(self):
+        return self.updated_at
+
+    @property
+    def syncReplyTo(self):
+        return self.sync_reply_to
+
+    @property
+    def feedbackQueue(self):
+        return self.feedback_queue
+
+    @property
+    def status(self):
+        return self._status
+
+    @property
+    def services(self):
+        assert isinstance(self._repositories.services, repositories.Services)
+        return self._repositories.services
+
+    @property
+    def executions(self):
+        assert isinstance(self._repositories.executions, repositories.Executions)
+        return self._repositories.executions
+
+    @staticmethod
+    def _protected_from_json(_json, client_api, project=None, service=None, is_fetched=True):
+        """
+        Same as from_json but with try-except to catch if error
+        :param _json: platform json
+        :param client_api: ApiClient entity
+        :return:
+        """
+        try:
+            execution = Execution.from_json(_json=_json,
+                                            client_api=client_api,
+                                            project=None,
+                                            service=service,
+                                            is_fetched=is_fetched)
+            status = True
+        except Exception:
+            execution = traceback.format_exc()
+            status = False
+        return status, execution
+
+    @classmethod
+    def from_json(cls, _json, client_api, project=None, service=None, is_fetched=True):
+        """
+        :param dict _json: platform json
+        :param dl.ApiClient client_api: ApiClient entity
+        :param dtlpy.entities.project.Project project: project entity
+        :param dtlpy.entities.service.Service service:
+        :param is_fetched: is Entity fetched from Platform
+        """
+        if project is not None:
+            if project.id != _json.get('projectId', None):
+                logger.warning('Execution has been fetched from a project that is not belong to it')
+                project = None
+
+        if service is not None:
+            if service.id != _json.get('serviceId', None):
+                logger.warning('Execution has been fetched from a service that is not belong to it')
+                service = None
+
+        inst = cls(
+            feedback_queue=_json.get('feedbackQueue', None),
+            service_id=_json.get('serviceId', None),
+            project_id=_json.get('projectId', None),
+            latest_status=_json.get('latestStatus', None),
+            sync_reply_to=_json.get('syncReplyTo', None),
+            created_at=_json.get('createdAt', None),
+            updated_at=_json.get('updatedAt', None),
+            creator=_json.get('creator', None),
+            trigger_id=_json.get('triggerId', None),
+            attempts=_json.get('attempts', None),
+            max_attempts=_json.get('maxAttempts', None),
+            output=_json.get('output', None),
+            status=_json.get('status', None),
+            status_log=_json.get('statusLog', None),
+            duration=_json.get('duration', None),
+            function_name=_json.get('functionName', entities.package_defaults.DEFAULT_PACKAGE_FUNCTION_NAME),
+            input=_json.get('input', None),
+            url=_json.get('url', None),
+            id=_json.get('id', None),
+            to_terminate=_json.get('toTerminate', False),
+            client_api=client_api,
+            project=project,
+            service=service,
+            service_version=_json.get('serviceVersion', False),
+            package_id=_json.get('packageId', None),
+            package_name=_json.get('packageName', None),
+            pipeline=_json.get('pipeline', None),
+            model=_json.get('model', None),
+            package_revision=_json.get('packageRevision', None),
+            app=_json.get('app', None),
+            driver_id=_json.get('driverId', None)
+        )
+        inst.is_fetched = is_fetched
+        return inst
+
+    def to_json(self):
+        """
+        Returns platform _json format of object
+
+        :return: platform json format of object
+        :rtype: dict
+        """
+        # get excluded
+        _json = attr.asdict(
+            self, filter=attr.filters.exclude(
+                attr.fields(Execution)._client_api,
+                attr.fields(Execution)._service,
+                attr.fields(Execution)._project,
+                attr.fields(Execution).to_terminate,
+                attr.fields(Execution)._repositories,
+                attr.fields(Execution).project_id,
+                attr.fields(Execution).service_id,
+                attr.fields(Execution).trigger_id,
+                attr.fields(Execution).function_name,
+                attr.fields(Execution).max_attempts,
+                attr.fields(Execution).latest_status,
+                attr.fields(Execution).service_version,
+                attr.fields(Execution).package_id,
+                attr.fields(Execution).package_name,
+                attr.fields(Execution).status_log,
+                attr.fields(Execution)._status,
+                attr.fields(Execution).created_at,
+                attr.fields(Execution).updated_at,
+                attr.fields(Execution).feedback_queue,
+                attr.fields(Execution).sync_reply_to,
+                attr.fields(Execution).pipeline,
+                attr.fields(Execution).model,
+                attr.fields(Execution).package_revision,
+                attr.fields(Execution).driver_id,
+            )
+        )
+
+        # rename
+        _json['projectId'] = self.project_id
+        _json['triggerId'] = self.trigger_id
+        _json['serviceId'] = self.service_id
+        _json['functionName'] = self.function_name
+        _json['latestStatus'] = self.latest_status
+        _json['maxAttempts'] = self.max_attempts
+        _json['toTerminate'] = self.to_terminate
+        _json['serviceVersion'] = self.service_version
+        _json['packageId'] = self.package_id
+        _json['packageName'] = self.package_name
+        _json['statusLog'] = self.status_log
+        _json['status'] = self._status
+        _json['createdAt'] = self.created_at
+        _json['updatedAt'] = self.updated_at
+        _json['feedbackQueue'] = self.feedback_queue
+        _json['syncReplyTo '] = self.sync_reply_to
+        _json['packageRevision'] = self.package_revision
+        _json['driverId'] = self.driver_id
+
+        if self.pipeline:
+            _json['pipeline'] = self.pipeline
+        if self.model:
+            _json['model'] = self.model
+
+        return _json
+
+    @property
+    def pipeline_id(self) -> str:
+        pipeline_id = None
+        if self.pipeline:
+            pipeline_id = self.pipeline.get('id', None)
+        return pipeline_id
+
+    @property
+    def node_id(self) -> str:
+        node_id = None
+        if self.pipeline:
+            node_id = self.pipeline.get('nodeId', None)
+        return node_id
+
+    @property
+    def pipeline_execution_id(self) -> str:
+        pipeline_execution_id = None
+        if self.pipeline:
+            pipeline_execution_id = self.pipeline.get('executionId', None)
+        return pipeline_execution_id
+
+    @property
+    def service(self):
+        if self._service is None:
+            self._service = self.services.get(service_id=self.service_id, fetch=None)
+        assert isinstance(self._service, entities.Service)
+        return self._service
+
+    @property
+    def project(self):
+        if self._project is None:
+            self._project = repositories.Projects(client_api=self._client_api).get(project_id=self.project_id,
+                                                                                   fetch=None)
+        assert isinstance(self._project, entities.Project)
+        return self._project
+
+    def get_latest_status(self):
+        self.latest_status = self.executions.get(execution_id=self.id).latest_status
+        return self.latest_status
+
+    @service.setter
+    def service(self, service):
+        if not isinstance(service, entities.Service):
+            raise ValueError('Must input a valid service entity')
+        self._service = service
+
+    def progress_update(
+            self,
+            status: ExecutionStatus = None,
+            percent_complete: int = None,
+            message: str = None,
+            output: str = None,
+            service_version: str = None
+    ):
+        """
+        Update Execution Progress
+
+        :param str status: ExecutionStatus
+        :param int percent_complete: percent complete
+        :param str message: message to update the progress state
+        :param str output: output
+        :param str service_version: service version
+        :return: Service execution object
+        """
+        return self.executions.progress_update(
+            execution_id=self.id,
+            status=status,
+            percent_complete=percent_complete,
+            message=message,
+            output=output,
+            service_version=service_version
+        )
+
+    def update(self):
+        """
+        Update execution changes to platform
+
+        :return: execution entity
+        """
+        return self.executions.update(execution=self)
+
+    def logs(self, follow=False, log_level='DEBUG'):
+        """
+        Print logs for execution
+
+        :param follow: keep stream future logs
+        :param str log_level: the log level to display
+        """
+        self.services.log(execution_id=self.id,
+                          view=True,
+                          service=self.service,
+                          follow=follow,
+                          start=self.created_at,
+                          log_level=log_level)
+
+    def increment(self):
+        """
+        Increment attempts
+
+        :return:
+        """
+        self.attempts = self.executions.increment(execution=self)
+
+    def rerun(self, sync: bool = False):
+        """
+        Re-run
+
+        :return: Execution object
+        """
+        return self.executions.rerun(execution=self, sync=sync)
+
+    def terminate(self):
+        """
+        Terminate execution
+
+        :return: execution object
+        """
+        return self.executions.terminate(execution=self)
+
+    def wait(self):
+        """
+        Wait for execution
+
+        :return: Service execution object
+        """
+        return self.executions.wait(execution_id=self.id)
+
+    def in_progress(self):
+        return self.latest_status['status'] not in [ExecutionStatus.FAILED,
+                                                    ExecutionStatus.SUCCESS,
+                                                    ExecutionStatus.TERMINATED,
+                                                    ExecutionStatus.ABORTED,
+                                                    ExecutionStatus.CANCELED,
+                                                    ExecutionStatus.SYSTEM_FAILURE]