pinexq-client 0.9.2.20250515.43__py3-none-any.whl → 0.9.2.20250716.44__py3-none-any.whl

pinexq_client/job_management/tool/job.py

@@ -1,9 +1,10 @@
 import json as json_
 import warnings
-from typing import Any, Self
+from typing import Any, Self, List
 
 import httpx
 from httpx import URL
+from pydantic import BaseModel, ConfigDict
 
 from pinexq_client.core import Link, MediaTypes, ClientException, ApiException
 from pinexq_client.core.polling import wait_until, PollingException
@@ -35,12 +36,51 @@ from pinexq_client.job_management.model import (
     SelectProcessingParameters,
     SelectWorkDataCollectionForDataSlotParameters,
     SelectWorkDataForDataSlotParameters,
-    SetJobTagsParameters, RapidJobSetupParameters,
+    SetJobTagsParameters, RapidJobSetupParameters, InputDataSlotParameter,
 )
 from pinexq_client.job_management.tool.processing_step import ProcessingStep
 from pinexq_client.job_management.tool.workdata import WorkData
 
 
+class InputDataSlotParameterFlexible(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+        arbitrary_types_allowed=True
+    )
+    index: int
+    work_data_urls: List[str] | None = None
+    work_data_instances: List[WorkData] | None = None
+
+    @classmethod
+    def create(cls, *,
+        index: int,
+        work_data_urls: List[WorkDataLink] | None = None,
+        work_data_instances: List[WorkData] | None = None
+    ) -> "InputDataSlotParameterFlexible":
+        """Creates an instance of InputDataSlotParameterFlexible that can be used to assign work data to a job.
+
+        Args:
+            index: The index of the input data slot.
+            work_data_urls: A list of URLs pointing to the work data.
+            work_data_instances: A list of WorkData instances.
+
+        Returns:
+            An instance of InputDataSlotParameterFlexible.
+        """
+        if sum(p is not None for p in [work_data_urls, work_data_instances]) != 1:
+            raise ValueError("Exactly one parameter must be provided")
+
+        if work_data_instances is not None:
+            if not isinstance(work_data_instances, list) or any(
+                    not isinstance(i, WorkData) for i in work_data_instances):
+                raise Exception('Instance passed to "work_data_instances" is not of type "list[WorkData]"')
+            work_data_urls = [work_data_instance.self_link() for work_data_instance in work_data_instances]
+        return InputDataSlotParameterFlexible(
+            index=index,
+            work_data_urls=[str(wd.get_url()) for wd in work_data_urls] if work_data_urls else None,
+            work_data_instances=None
+        )
+
 class Job:
     """Convenience wrapper for handling JobHcos in the JobManagement-Api.
 
@@ -61,7 +101,7 @@ class Job:
     _entrypoint: EntryPointHco
     _jobs_root: JobsRootHco
     _processing_step_root: ProcessingStepsRootHco
-    job_hco: JobHco | None = None # Internal hco of the wrapper. This is updated by this class. You should not take a reference to this object.
+    job_hco: JobHco | None = None  # Internal hco of the wrapper. This is updated by this class. You should not take a reference to this object.
 
     def __init__(self, client: httpx.Client):
         """
@@ -313,6 +353,19 @@ class Job:
 
         return self
 
+    def wait_for_completion(self, timeout_ms: int = 60000, polling_interval_ms: int = 500) -> Self:
+        """Wait for this job to reach the state 'completed'.
+
+        Args:
+            timeout_ms: Timeout to wait for the job to reach the next state.
+            polling_interval_ms: will determine how fast the API is polled for updates.
+            Note that low values will produce unnecessary load.
+
+        Returns:
+            This `Job` object
+        """
+        return self.wait_for_state(JobStates.completed, timeout_ms, polling_interval_ms)
+
     def assign_input_dataslot(
             self,
             index: int,
@@ -564,7 +617,7 @@ class Job:
 
         job_was_deleted = False
         try:
-            if  self.job_hco.delete_action.is_available():
+            if self.job_hco.delete_action.is_available():
                 self.job_hco.delete_action.execute()
                 # do not delete the hco here since we want to access its data slots just below
                 job_was_deleted = True
@@ -663,7 +716,17 @@ class Job:
 
     def create_and_configure_rapidly(
             self,
-            parameters: RapidJobSetupParameters
+            *,
+            name: str,
+            parent_job_url: JobLink | None = None,
+            parent_job_instance: Self | None = None,
+            tags: list[str] | None = None,
+            processing_step_url: ProcessingStepLink | None = None,
+            processing_step_instance: ProcessingStep | None = None,
+            start: bool = True,
+            parameters: str | None = None,
+            allow_output_data_slots: bool | None = None,
+            input_data_slots: List[InputDataSlotParameterFlexible] | None = None,
     ) -> Self:
         """
         Creates a new job and configures it rapidly with RapidJobSetupParameters.
@@ -674,7 +737,54 @@ class Job:
         Returns:
             The newly created job as `Job` object
         """
-        job_link = self._jobs_root.rapid_job_setup_action.execute(parameters)
+
+        # handle parent job
+        if sum(p is not None for p in [parent_job_url, parent_job_instance]) > 1:
+            raise ValueError("Either none or at most 1 one of parent_job_url or parent_job_instance must be provided")
+        parent_job = None
+        if parent_job_instance is not None:
+            if not isinstance(parent_job_instance, Job):
+                raise Exception('Instance passed to "parent_job_instance" is not of type "Job"')
+            parent_job = parent_job_instance.self_link().get_url()
+        elif parent_job_url is not None:
+            if not isinstance(parent_job_url, JobLink):
+                raise Exception('Instance passed to "parent_job_url" is not of type "JobLink"')
+            parent_job = parent_job_url.get_url()
+
+        # handle processing step
+        if sum(p is not None for p in [processing_step_url, processing_step_instance]) != 1:
+            raise ValueError("Exactly one of processing_step_url or processing_step_instance must be provided")
+        if processing_step_instance is not None:
+            if not isinstance(processing_step_instance, ProcessingStep):
+                raise Exception('Instance passed to "processing_step_instance" is not of type "ProcessingStep"')
+            processing_step = processing_step_instance.self_link().get_url()
+        else:
+            if not isinstance(processing_step_url, ProcessingStepLink):
+                raise Exception('Instance passed to "processing_step_url" is not of type "ProcessingStepLink"')
+            processing_step = processing_step_url.get_url()
+
+        # handle input data slots
+        if input_data_slots is not None:
+            input_data_slots = [
+                InputDataSlotParameter(
+                    Index=slot.index,
+                    WorkDataUrls=slot.work_data_urls
+                ) for slot in input_data_slots
+            ]
+
+        # build RapidJobSetupParameters
+        params = RapidJobSetupParameters(
+            Name=name,
+            ParentJobUrl=None if parent_job is None else str(parent_job),
+            ProcessingStepUrl=str(processing_step),
+            Tags=tags,
+            Start=start,
+            Parameters=parameters,
+            AllowOutputDataDeletion=allow_output_data_slots,
+            InputDataSlots=input_data_slots
+        )
+
+        job_link = self._jobs_root.rapid_job_setup_action.execute(params)
         self._get_by_link(job_link)
         return self
 

{pinexq_client-0.9.2.20250515.43.dist-info → pinexq_client-0.9.2.20250716.44.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pinexq-client
-Version: 0.9.2.20250515.43
+Version: 0.9.2.20250716.44
 Summary: A hypermedia-based client for the DataCybernetics PinexQ platform.
 Author-Email: =?utf-8?q?Sebastian_H=C3=B6fer?= <hoefer@data-cybernetics.com>, Mathias Reichardt <reichardt@data-cybernetics.com>, Jasim Ahmed <ahmed@data-cybernetics.com>, Pratik Poudel <poudel@data-cybernetics.com>
 Maintainer-Email: Mathias Reichardt <reichardt@data-cybernetics.com>, =?utf-8?q?Sebastian_H=C3=B6fer?= <hoefer@data-cybernetics.com>, Carsten Blank <blank@data-cybernetics.com>

{pinexq_client-0.9.2.20250515.43.dist-info → pinexq_client-0.9.2.20250716.44.dist-info}/RECORD

@@ -1,7 +1,7 @@
-pinexq_client-0.9.2.20250515.43.dist-info/METADATA,sha256=0WwpBhk9GA6PUPIi3nDnyX9fvaaRIb9nloEjn2OVsBk,3279
-pinexq_client-0.9.2.20250515.43.dist-info/WHEEL,sha256=tSfRZzRHthuv7vxpI4aehrdN9scLjk-dCJkPLzkHxGg,90
-pinexq_client-0.9.2.20250515.43.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
-pinexq_client-0.9.2.20250515.43.dist-info/licenses/LICENSE,sha256=3oz3tAhM7kOgRukkRe7wmh5T_HihZY77ZtJDJm91ZN8,1072
+pinexq_client-0.9.2.20250716.44.dist-info/METADATA,sha256=d2Xxx8jzezOpdVEJrGiLUdb5b7Y5mB5S5x6WCb8pn6g,3279
+pinexq_client-0.9.2.20250716.44.dist-info/WHEEL,sha256=9P2ygRxDrTJz3gsagc0Z96ukrxjr-LFBGOgv3AuKlCA,90
+pinexq_client-0.9.2.20250716.44.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
+pinexq_client-0.9.2.20250716.44.dist-info/licenses/LICENSE,sha256=3oz3tAhM7kOgRukkRe7wmh5T_HihZY77ZtJDJm91ZN8,1072
 pinexq_client/core/__init__.py,sha256=zO9vUuAl6AEokL-SqQO3Jl1qrxFBZPA2kH99VNZugEU,598
 pinexq_client/core/base_relations.py,sha256=oIUS58pkbMDdqm-3YOdsenhL1smtzeAk4fp7-U595MY,162
 pinexq_client/core/enterapi.py,sha256=eB4F2_t3lCbMgKhy-M-Sf_u9MhuJMO7OGh-GB-4Cc-8,731
@@ -46,8 +46,8 @@ pinexq_client/job_management/model/__init__.py,sha256=iuAKRXdW_Mxo0i3HsBfEzhJJZU
 pinexq_client/job_management/model/open_api_generated.py,sha256=s-XtnhuK5YmBhbOqKsy09iRKrQMtZL6-N2be-g5d8QU,33211
 pinexq_client/job_management/model/sirenentities.py,sha256=MUjgByEwzQcrduCEJuNK85uAj8SLTdyaiKmnlB44h3E,3430
 pinexq_client/job_management/tool/__init__.py,sha256=zPobd-hQyANHzC0-TjJG91z9XrewvE54ZJ6VViymW5M,128
-pinexq_client/job_management/tool/job.py,sha256=p9WDfJiIcQMZyLfNajpxK9kSd0DqF2H9hoS7lvDIFC0,25496
+pinexq_client/job_management/tool/job.py,sha256=yVEVE3RRalQy8abA2G1X-a1Tj3v32YCsDeN52LDMSp8,30572
 pinexq_client/job_management/tool/job_group.py,sha256=TNWw46UDyP2gmArhbzMAqpHa6lS2hzwarLIrxxpOMnk,4822
 pinexq_client/job_management/tool/processing_step.py,sha256=LLesEbS7vaAiCoGs7MV8bnaD8bWnkK-2YTxAsyPiJFM,10796
 pinexq_client/job_management/tool/workdata.py,sha256=wRy_yfFZUJDh-hoGUuAbQaRGtPysDmEOhLwD84Fgz04,5510
-pinexq_client-0.9.2.20250515.43.dist-info/RECORD,,
+pinexq_client-0.9.2.20250716.44.dist-info/RECORD,,

{pinexq_client-0.9.2.20250515.43.dist-info → pinexq_client-0.9.2.20250716.44.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: pdm-backend (2.4.4)
+Generator: pdm-backend (2.4.5)
 Root-Is-Purelib: true
 Tag: py3-none-any