dtlpy 1.113.10__py3-none-any.whl → 1.114.13__py3-none-any.whl

dtlpy/repositories/commands.py

@@ -1,158 +1,158 @@
-import numpy as np
-import logging
-import time
-import tqdm
-import sys
-
-from .. import exceptions, entities, miscellaneous
-from ..services.api_client import ApiClient
-
-logger = logging.getLogger(name='dtlpy')
-
-MAX_SLEEP_TIME = 30
-
-
-class Commands:
-    """
-    Service Commands repository
-    """
-
-    def __init__(self, client_api: ApiClient):
-        self._client_api = client_api
-
-    ############
-    # entities #
-    ############
-
-    def list(self):
-        """
-        List of commands
-
-        :return: list of commands
-        """
-        url = '/commands'
-
-        # request
-        success, response = self._client_api.gen_request(req_type='get',
-                                                         path=url)
-        if not success:
-            raise exceptions.PlatformException(response)
-
-        commands = miscellaneous.List([entities.Command.from_json(_json=_json,
-                                                                  client_api=self._client_api) for _json in
-                                       response.json()])
-        return commands
-
-    def get(self,
-            command_id: str = None,
-            url: str = None
-            ) -> entities.Command:
-        """
-        Get Service command object
-
-        :param str command_id:
-        :param str url: command url
-        :return: Command object
-        """
-        if url is None:
-            url_path = "/commands/{}".format(command_id)
-        else:
-            url_path = url.split('api/v1')[1]
-
-        success, response = self._client_api.gen_request(req_type="get",
-                                                         path=url_path)
-
-        # exception handling
-        if not success:
-            raise exceptions.PlatformException(response)
-
-        # return entity
-        return entities.Command.from_json(client_api=self._client_api,
-                                          _json=response.json())
-
-    def wait(self, command_id, timeout=0, step=None, url=None, backoff_factor=1, iteration_callback=None):
-        """
-        Wait for command to finish
-
-        backoff_factor: A backoff factor to apply between attempts after the second try
-        {backoff factor} * (2 ** ({number of total retries} - 1))
-        seconds. If the backoff_factor is 1, then :func:`.sleep` will sleep
-        for [0s, 2s, 4s, ...] between retries. It will never be longer
-        than 30 sec
-
-        :param str command_id: Command id to wait to
-        :param int timeout: int, seconds to wait until TimeoutError is raised. if 0 - wait until done
-        :param int step: int, seconds between polling
-        :param str url: url to the command
-        :param function iteration_callback: function to call on each iteration
-        :param float backoff_factor: A backoff factor to apply between attempts after the second try
-        :return: Command  object
-        """
-
-        elapsed = 0
-        start = time.time()
-        if timeout is None or timeout <= 0:
-            timeout = np.inf
-
-        command = None
-        pbar = tqdm.tqdm(total=100,
-                         disable=self._client_api.verbose.disable_progress_bar_command_progress,
-                         file=sys.stdout,
-                         desc='Command Progress')
-        num_tries = 1
-        while elapsed < timeout:
-            command = self.get(command_id=command_id, url=url)
-            if command.type == 'ExportDatasetAsJson':
-                self._client_api.callbacks.run_on_event(event=self._client_api.callbacks.CallbackEvent.DATASET_EXPORT,
-                                                        context=command.spec,
-                                                        progress=command.progress)
-
-            pbar.update(command.progress - pbar.n)
-            if not command.in_progress():
-                break
-            elapsed = time.time() - start
-            sleep_time = np.min([timeout - elapsed, backoff_factor * (2 ** num_tries), MAX_SLEEP_TIME])
-            num_tries += 1
-            logger.debug(
-                "Command {!r} is running for {:.2f}[s] and now Going to sleep {:.2f}[s]".format(
-                    command.id,
-                    elapsed,
-                    sleep_time
-                )
-            )
-            if iteration_callback is not None:
-                try:
-                    iteration_callback()
-                except Exception as e:
-                    logger.warning('iteration_callback failed: {}'.format(e.__str__()))
-            time.sleep(sleep_time)
-        pbar.close()
-        if command is None:
-            raise ValueError('Nothing to wait for')
-        if elapsed >= timeout:
-            raise TimeoutError("command wait() got timeout. id: {!r}, status: {}, progress {}%".format(
-                command.id, command.status, command.progress))
-        if command.status != entities.CommandsStatus.SUCCESS:
-            raise exceptions.PlatformException(error='424',
-                                               message="Command {!r} {}: '{}'".format(command.id,
-                                                                                      command.status,
-                                                                                      command.error))
-        return command
-
-    def abort(self, command_id: str):
-        """
-        Abort Command
-
-        :param str command_id: command id
-        :return:
-        """
-        # request
-        success, response = self._client_api.gen_request(req_type='post',
-                                                         path='/commands/{}/abort'.format(command_id))
-
-        # exception handling
-        if not success:
-            raise exceptions.PlatformException(response)
-        else:
-            return entities.Command.from_json(_json=response.json(),
-                                              client_api=self._client_api)
+import numpy as np
+import logging
+import time
+import tqdm
+import sys
+
+from .. import exceptions, entities, miscellaneous
+from ..services.api_client import ApiClient
+
+logger = logging.getLogger(name='dtlpy')
+
+MAX_SLEEP_TIME = 30
+
+
+class Commands:
+    """
+    Service Commands repository
+    """
+
+    def __init__(self, client_api: ApiClient):
+        self._client_api = client_api
+
+    ############
+    # entities #
+    ############
+
+    def list(self):
+        """
+        List of commands
+
+        :return: list of commands
+        """
+        url = '/commands'
+
+        # request
+        success, response = self._client_api.gen_request(req_type='get',
+                                                         path=url)
+        if not success:
+            raise exceptions.PlatformException(response)
+
+        commands = miscellaneous.List([entities.Command.from_json(_json=_json,
+                                                                  client_api=self._client_api) for _json in
+                                       response.json()])
+        return commands
+
+    def get(self,
+            command_id: str = None,
+            url: str = None
+            ) -> entities.Command:
+        """
+        Get Service command object
+
+        :param str command_id:
+        :param str url: command url
+        :return: Command object
+        """
+        if url is None:
+            url_path = "/commands/{}".format(command_id)
+        else:
+            url_path = url.split('api/v1')[1]
+
+        success, response = self._client_api.gen_request(req_type="get",
+                                                         path=url_path)
+
+        # exception handling
+        if not success:
+            raise exceptions.PlatformException(response)
+
+        # return entity
+        return entities.Command.from_json(client_api=self._client_api,
+                                          _json=response.json())
+
+    def wait(self, command_id, timeout=0, step=None, url=None, backoff_factor=1, iteration_callback=None):
+        """
+        Wait for command to finish
+
+        backoff_factor: A backoff factor to apply between attempts after the second try
+        {backoff factor} * (2 ** ({number of total retries} - 1))
+        seconds. If the backoff_factor is 1, then :func:`.sleep` will sleep
+        for [0s, 2s, 4s, ...] between retries. It will never be longer
+        than 30 sec
+
+        :param str command_id: Command id to wait to
+        :param int timeout: int, seconds to wait until TimeoutError is raised. if 0 - wait until done
+        :param int step: int, seconds between polling
+        :param str url: url to the command
+        :param function iteration_callback: function to call on each iteration
+        :param float backoff_factor: A backoff factor to apply between attempts after the second try
+        :return: Command  object
+        """
+
+        elapsed = 0
+        start = time.time()
+        if timeout is None or timeout <= 0:
+            timeout = np.inf
+
+        command = None
+        pbar = tqdm.tqdm(total=100,
+                         disable=self._client_api.verbose.disable_progress_bar_command_progress,
+                         file=sys.stdout,
+                         desc='Command Progress')
+        num_tries = 1
+        while elapsed < timeout:
+            command = self.get(command_id=command_id, url=url)
+            if command.type == 'ExportDatasetAsJson':
+                self._client_api.callbacks.run_on_event(event=self._client_api.callbacks.CallbackEvent.DATASET_EXPORT,
+                                                        context=command.spec,
+                                                        progress=command.progress)
+
+            pbar.update(command.progress - pbar.n)
+            if not command.in_progress():
+                break
+            elapsed = time.time() - start
+            sleep_time = np.min([timeout - elapsed, backoff_factor * (2 ** num_tries), MAX_SLEEP_TIME])
+            num_tries += 1
+            logger.debug(
+                "Command {!r} is running for {:.2f}[s] and now Going to sleep {:.2f}[s]".format(
+                    command.id,
+                    elapsed,
+                    sleep_time
+                )
+            )
+            if iteration_callback is not None:
+                try:
+                    iteration_callback()
+                except Exception as e:
+                    logger.warning('iteration_callback failed: {}'.format(e.__str__()))
+            time.sleep(sleep_time)
+        pbar.close()
+        if command is None:
+            raise ValueError('Nothing to wait for')
+        if elapsed >= timeout:
+            raise TimeoutError("command wait() got timeout. id: {!r}, status: {}, progress {}%".format(
+                command.id, command.status, command.progress))
+        if command.status != entities.CommandsStatus.SUCCESS:
+            raise exceptions.PlatformException(error='424',
+                                               message="Command {!r} {}: '{}'".format(command.id,
+                                                                                      command.status,
+                                                                                      command.error))
+        return command
+
+    def abort(self, command_id: str):
+        """
+        Abort Command
+
+        :param str command_id: command id
+        :return:
+        """
+        # request
+        success, response = self._client_api.gen_request(req_type='post',
+                                                         path='/commands/{}/abort'.format(command_id))
+
+        # exception handling
+        if not success:
+            raise exceptions.PlatformException(response)
+        else:
+            return entities.Command.from_json(_json=response.json(),
+                                              client_api=self._client_api)

dtlpy/repositories/compositions.py

@@ -1,61 +1,61 @@
-import logging
-from .. import entities, repositories, exceptions, miscellaneous, _api_reference
-from ..services.api_client import ApiClient
-
-logger = logging.getLogger(name='dtlpy')
-
-
-class Compositions:
-    def __init__(self, client_api: ApiClient, project: entities.Project = None):
-        self._client_api = client_api
-        self._project = project
-
-    ############
-    # entities #
-    ############
-    @property
-    def project(self) -> entities.Project:
-        if self._project is None:
-            try:
-                self._project = repositories.Projects(client_api=self._client_api).get()
-            except exceptions.NotFound:
-                raise exceptions.PlatformException(
-                    error='2001',
-                    message='Missing "project". need to set a Project entity or use project.pipelines repository')
-        return self._project
-
-    @project.setter
-    def project(self, project: entities.Project):
-        if not isinstance(project, entities.Project):
-            raise ValueError('Must input a valid Project entity')
-        self._project = project
-
-    def get(self,
-            composition_id=None,
-            fetch=None
-            ) -> entities.Pipeline:
-
-        if fetch is None:
-            fetch = self._client_api.fetch_entities
-
-        if composition_id is None:
-            raise exceptions.PlatformException(
-                error='400',
-                message='Must provide an identifier in inputs')
-
-        elif fetch:
-            if composition_id is not None:
-                success, response = self._client_api.gen_request(
-                    req_type="get",
-                    path="/compositions/{}".format(composition_id))
-                if not success:
-                    raise exceptions.PlatformException(response)
-                composition = response.json()
-            else:
-                raise exceptions.PlatformException(
-                    error='400',
-                    message='No checked-out pipeline was found, must checkout or provide an identifier in inputs')
-        else:
-            composition = {'id': composition_id}
-
-        return composition
+import logging
+from .. import entities, repositories, exceptions, miscellaneous, _api_reference
+from ..services.api_client import ApiClient
+
+logger = logging.getLogger(name='dtlpy')
+
+
+class Compositions:
+    def __init__(self, client_api: ApiClient, project: entities.Project = None):
+        self._client_api = client_api
+        self._project = project
+
+    ############
+    # entities #
+    ############
+    @property
+    def project(self) -> entities.Project:
+        if self._project is None:
+            try:
+                self._project = repositories.Projects(client_api=self._client_api).get()
+            except exceptions.NotFound:
+                raise exceptions.PlatformException(
+                    error='2001',
+                    message='Missing "project". need to set a Project entity or use project.pipelines repository')
+        return self._project
+
+    @project.setter
+    def project(self, project: entities.Project):
+        if not isinstance(project, entities.Project):
+            raise ValueError('Must input a valid Project entity')
+        self._project = project
+
+    def get(self,
+            composition_id=None,
+            fetch=None
+            ) -> entities.Pipeline:
+
+        if fetch is None:
+            fetch = self._client_api.fetch_entities
+
+        if composition_id is None:
+            raise exceptions.PlatformException(
+                error='400',
+                message='Must provide an identifier in inputs')
+
+        elif fetch:
+            if composition_id is not None:
+                success, response = self._client_api.gen_request(
+                    req_type="get",
+                    path="/compositions/{}".format(composition_id))
+                if not success:
+                    raise exceptions.PlatformException(response)
+                composition = response.json()
+            else:
+                raise exceptions.PlatformException(
+                    error='400',
+                    message='No checked-out pipeline was found, must checkout or provide an identifier in inputs')
+        else:
+            composition = {'id': composition_id}
+
+        return composition