Source code for dtlpy.repositories.pipeline_executions

import logging
from .. import entities, repositories, exceptions, miscellaneous, services, _api_reference
from ..services.api_client import ApiClient

logger = logging.getLogger(name='dtlpy')


[docs]class PipelineExecutions: """ PipelineExecutions Repository The PipelineExecutions class allows users to manage pipeline executions. See our documentation for more information on `pipelines <https://dataloop.ai/docs/pipelines-overview>`_. """ def __init__( self, client_api: ApiClient, project: entities.Project = None, pipeline: entities.Pipeline = None ): self._client_api = client_api self._project = project self._pipeline = pipeline ############ # 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 @property def pipeline(self) -> entities.Pipeline: assert isinstance(self._pipeline, entities.Pipeline) return self._pipeline @pipeline.setter def pipeline(self, pipeline: entities.Pipeline): if not isinstance(pipeline, entities.Pipeline): raise ValueError('Must input a valid pipeline entity') self._pipeline = pipeline ########### # methods # ########### # @_api_reference.add(path='/pipelines/{pipelineId}/executions/{executionId}', method='get')
[docs] def get(self, pipeline_execution_id: str, pipeline_id: str = None ) -> entities.PipelineExecution: """ Get Pipeline Execution object **prerequisites**: You must be an *owner* or *developer* to use this method. :param str pipeline_execution_id: pipeline execution id :param str pipeline_id: pipeline id :return: PipelineExecution object :rtype: dtlpy.entities.pipeline_execution.PipelineExecution **Example**: .. code-block:: python pipeline_executions = pipeline.pipeline_executions.get(pipeline_id='pipeline_id') """ if pipeline_id is None and self._pipeline is None: raise exceptions.PlatformException('400', 'Must provide param pipeline_id') elif pipeline_id is None: pipeline_id = self._pipeline.id success, response = self._client_api.gen_request( req_type="get", path="/pipelines/{pipeline_id}/executions/{pipeline_execution_id}".format( pipeline_id=pipeline_id, pipeline_execution_id=pipeline_execution_id ) ) if not success: raise exceptions.PlatformException(response) pipeline_execution = entities.PipelineExecution.from_json( client_api=self._client_api, _json=response.json(), pipeline=self._pipeline ) return pipeline_execution
def _build_entities_from_response(self, response_items) -> miscellaneous.List[entities.PipelineExecution]: pool = self._client_api.thread_pools(pool_name='entity.create') jobs = [None for _ in range(len(response_items))] for i_pipeline_execution, pipeline_execution in enumerate(response_items): jobs[i_pipeline_execution] = pool.submit( entities.PipelineExecution._protected_from_json, **{ 'client_api': self._client_api, '_json': pipeline_execution, 'pipeline': self._pipeline } ) # get all results # noinspection PyUnresolvedReferences results = [j.result() for j in jobs] # log errors _ = [logger.warning(r[1]) for r in results if r[0] is False] # return good jobs pipeline_executions = miscellaneous.List([r[1] for r in results if r[0] is True]) return pipeline_executions def _list(self, filters: entities.Filters): url = '/pipelines/query' # request success, response = self._client_api.gen_request( req_type='post', path=url, json_req=filters.prepare() ) if not success: raise exceptions.PlatformException(response) return response.json()
[docs] @_api_reference.add(path='/pipelines/query', method='post') def list(self, filters: entities.Filters = None) -> entities.PagedEntities: """ List project pipeline executions. **prerequisites**: You must be an *owner* or *developer* to use this method. :param dtlpy.entities.filters.Filters filters: Filters entity or a dictionary containing filters parameters :return: Paged entity :rtype: dtlpy.entities.paged_entities.PagedEntities **Example**: .. code-block:: python pipeline_executions = pipeline.pipeline_executions.list() """ if filters is None: filters = entities.Filters(resource=entities.FiltersResource.PIPELINE_EXECUTION) # assert type filters elif not isinstance(filters, entities.Filters): raise exceptions.PlatformException(error='400', message='Unknown filters type: {!r}'.format(type(filters))) if filters.resource != entities.FiltersResource.PIPELINE_EXECUTION: raise exceptions.PlatformException( error='400', message='Filters resource must to be FiltersResource.PIPELINE_EXECUTION. Got: {!r}'.format( filters.resource)) project_id = None if self._project is not None: project_id = self._project.id # TODO - uncomment this after DAT-24496 is done and cycles have projectId # if self._project is not None: # filters.add(field='projectId', values=self.project.id) if self._pipeline is not None: filters.add(field='pipelineId', values=self._pipeline.id) paged = entities.PagedEntities( items_repository=self, filters=filters, page_offset=filters.page, page_size=filters.page_size, project_id=project_id, client_api=self._client_api ) paged.get_page() return paged
[docs] @_api_reference.add(path='/pipelines/{pipelineId}/execute', method='post') def create(self, pipeline_id: str = None, execution_input=None): """ Execute a pipeline and return the execute. **prerequisites**: You must be an *owner* or *developer* to use this method. :param pipeline_id: pipeline id :param execution_input: list of the dl.FunctionIO or dict of pipeline input - example {'item': 'item_id'} :return: entities.PipelineExecution object :rtype: dtlpy.entities.pipeline_execution.PipelineExecution **Example**: .. code-block:: python pipeline_execution = pipeline.pipeline_executions.create(pipeline_id='pipeline_id', execution_input={'item': 'item_id'}) """ if pipeline_id is None: if self._pipeline is None: raise exceptions.PlatformException('400', 'Please provide pipeline id') pipeline_id = self._pipeline.id payload = dict() if execution_input is None: # support pipeline executions without any input pass elif isinstance(execution_input, dict): payload['input'] = execution_input else: if not isinstance(execution_input, list): execution_input = [execution_input] if len(execution_input) > 0 and isinstance(execution_input[0], entities.FunctionIO): payload['input'] = dict() for single_input in execution_input: payload['input'].update(single_input.to_json(resource='execution')) else: raise exceptions.PlatformException('400', 'Unknown input type') success, response = self._client_api.gen_request( path='/pipelines/{}/execute'.format(pipeline_id), req_type='POST', json_req=payload ) if not success: raise exceptions.PlatformException(response) execution = entities.PipelineExecution.from_json(_json=response.json(), client_api=self._client_api, pipeline=self._pipeline) return execution
[docs] @_api_reference.add(path='/pipelines/{pipelineId}/execute', method='post') def create_batch(self, pipeline_id: str, filters, execution_inputs=None, wait=True): """ Execute a pipeline and return the execute. **prerequisites**: You must be an *owner* or *developer* to use this method. :param pipeline_id: pipeline id :param filters: Filters entity for a filtering before execute :param execution_inputs: list of the dl.FunctionIO or dict of pipeline input - example {'item': 'item_id'}, that represent the extra inputs of the function :param bool wait: wait until create task finish :return: entities.PipelineExecution object :rtype: dtlpy.entities.pipeline_execution.PipelineExecution **Example**: .. code-block:: python command = pipeline.pipeline_executions.create_batch( execution_inputs=dl.FunctionIO(type=dl.PackageInputType.STRING, value='test', name='string'), filters=dl.Filters(field='dir', values='/test')) """ if pipeline_id is None: if self._pipeline is None: raise exceptions.PlatformException('400', 'Please provide pipeline id') pipeline_id = self._pipeline.id if filters is None: raise exceptions.PlatformException('400', 'Please provide filter') extra_input = dict() if execution_inputs is None: execution_inputs = {} if isinstance(execution_inputs, dict): extra_input = execution_inputs else: if not isinstance(execution_inputs, list): execution_inputs = [execution_inputs] if len(execution_inputs) > 0 and isinstance(execution_inputs[0], entities.FunctionIO): for single_input in execution_inputs: extra_input.update(single_input.to_json(resource='execution')) else: raise exceptions.PlatformException('400', 'Unknown input type') payload = dict() payload['batch'] = dict() payload['batch']['query'] = filters.prepare() payload['batch']['args'] = extra_input success, response = self._client_api.gen_request( path='/pipelines/{}/execute'.format(pipeline_id), req_type='POST', json_req=payload ) if not success: raise exceptions.PlatformException(response) response_json = response.json() command = entities.Command.from_json(_json=response_json, client_api=self._client_api) if wait: command = command.wait(timeout=0) return command
[docs] @_api_reference.add(path='/pipelines/{pipelineId}/executions/rerun', method='post') def rerun(self, pipeline_id: str = None, method: str = None, start_nodes_ids: list = None, filters: entities.Filters = None, wait: bool = True ) -> bool: """ Get Pipeline Execution object **prerequisites**: You must be an *owner* or *developer* to use this method. :param str pipeline_id: pipeline id :param str method: method to run :param list start_nodes_ids: list of start nodes ids :param filters: Filters entity for a filtering before execute :param bool wait: wait until rerun finish :return: True if success :rtype: bool **Example**: .. code-block:: python pipeline.pipeline_executions.rerun(pipeline_id='pipeline_id', method=dl.CycleRerunMethod.START_FROM_BEGINNING) """ if pipeline_id is None and self._pipeline is None: raise exceptions.PlatformException('400', 'Must provide param pipeline_id') elif pipeline_id is None: pipeline_id = self._pipeline.id if filters is None: filters = entities.Filters(resource=entities.FiltersResource.PIPELINE_EXECUTION) success, response = self._client_api.gen_request( req_type="post", path="/pipelines/{pipeline_id}/executions/rerun".format( pipeline_id=pipeline_id, ), json_req={ 'pipeline': { "method": method, "startNodeIds": start_nodes_ids, }, "batch": { "query": filters.prepare() } } ) if not success: raise exceptions.PlatformException(response) command = entities.Command.from_json(_json=response.json(), client_api=self._client_api) if not wait: return command command = command.wait(timeout=0) if 'cycleOptions' not in command.spec: raise exceptions.PlatformException(error='400', message="cycleOptions key is missing in command response: {!r}" .format(response)) return True