pinexq-client 0.4.0.2024.717.1__py3-none-any.whl → 0.4.2.20241009.1__py3-none-any.whl

pinexq_client/job_management/__init__.py

@@ -3,4 +3,4 @@ from .enterjma import enter_jma
 from .tool import Job, ProcessingStep, WorkData
 
 # Protocol version the JMA is using
-__jma_version__ = [6, 2, 0]
+__jma_version__ = [6, 2, 3]

pinexq_client/job_management/model/open_api_generated.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  openapi.json
-#   timestamp: 2024-06-17T15:26:52+00:00
+#   timestamp: 2024-09-24T10:14:32+00:00
 
 from __future__ import annotations
 
@@ -58,6 +58,7 @@ class CreateProcessingStepParameters(BaseModel):
     )
     title: constr(min_length=1) = Field(..., alias='Title')
     function_name: constr(min_length=1) = Field(..., alias='FunctionName')
+    version: constr(min_length=1) = Field(..., alias='Version')
 
 
 class CreateSubJobParameters(BaseModel):
@@ -785,6 +786,7 @@ class WorkDataHtoOpenApiProperties(BaseModel):
     media_type: str | None = Field(None, alias='MediaType')
     kind: WorkDataKind | None = Field(None, alias='Kind')
     is_deletable: bool | None = Field(None, alias='IsDeletable')
+    is_used_as_job_input: bool | None = Field(None, alias='IsUsedAsJobInput')
     hidden: bool | None = Field(None, alias='Hidden')
     comments: str | None = Field(None, alias='Comments')
 

pinexq_client/job_management/tool/job.py

@@ -197,15 +197,15 @@ class Job:
 
         if processing_step_link is not None:
             if not isinstance(processing_step_link, ProcessingStepLink):
-                raise Exception('Instance passed to "processing_step_link" is not of type "ProcessingStepLink"')
+                raise TypeError('Instance passed to "processing_step_link" is not of type "ProcessingStepLink"')
             processing_url = processing_step_link.get_url()
         elif 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"')
+                raise TypeError('Instance passed to "processing_step_instance" is not of type "ProcessingStep"')
             processing_url = processing_step_instance.self_link().get_url()
         else:
             if not isinstance(function_name, str):
-                raise Exception('Instance passed to "function_name" is not of type "str"')
+                raise TypeError('Instance passed to "function_name" is not of type "str"')
             # ToDo: provide more parameters to query a processing step
             query_param = ProcessingStepQueryParameters(
                 filter=ProcessingStepFilterParameter(
@@ -215,7 +215,7 @@ class Job:
             )
             query_result = self._processing_step_root.query_action.execute(query_param)
             if len(query_result.processing_steps) != 1:
-                raise AttributeError(f"No processing step with the name '{function_name}' registered!")
+                raise NameError(f"No processing step with the name '{function_name}' registered!")
             # Todo: For now we choose the first and only result. Make this more flexible?
             processing_url = query_result.processing_steps[0].self_link.get_url()
 
@@ -292,15 +292,15 @@ class Job:
                 polling_interval_ms=polling_interval_ms
             )
         except TimeoutError as timeout:
-            raise Exception(
+            raise TimeoutError(
                 f"Job did not reach state: '{state.value}' "
                 f"current state: '{self.get_state().value}'. Error:{str(timeout)}"
             )
         except PollingException:
             if self._job.state == JobStates.error:
                 error_reason = self._job.error_description
-                raise Exception(f"Job failed'. Error:{error_reason}")
-            raise Exception("Job failed")
+                raise PollingException(f"Job failed'. Error:{error_reason}")
+            raise PollingException("Job failed")
 
         return self
 

pinexq_client/job_management/tool/job_group.py

@@ -1,3 +1,4 @@
+import time
 from typing import Union, Self
 
 import httpx
@@ -8,133 +9,150 @@ from pinexq_client.job_management.model import JobStates
 
 
 class JobGroup:
-	"""
-	A wrapper class for a group of jobs for easier execution and waiting
-
-	Attributes:
-		_client:
-			The http client
-		_jobs:
-			List of jobs in the group
-	"""
-
-	_client: httpx.Client
-
-	def __init__(self, client: httpx.Client):
-		self._jobs: list[Job] = []
-		self._client = client
-
-	@classmethod
-	def from_query_result(cls, client: httpx.Client, job_query_result: JobQueryResultHco) -> Self:
-		"""
-		Initializes a `JobGroup` object from a JobQueryResultHco object
-		Args:
-			client: The http client
-			job_query_result: The JobQueryResultHco object whose jobs are to be added to the JobGroup
-
-		Returns:
-			The newly created `JobGroup` instance
-		"""
-		instance = cls(client)
-		for job in job_query_result.iter_flat():
-			instance.add_jobs(Job.from_hco(instance._client, job))
-		return instance
-
-	def add_jobs(self, jobs: Union[Job, list[Job]]) -> Self:
-		"""
-		Add a job or multiple jobs to the group
-
-		Args:
-			jobs: A job or a list of job objects to be added to the JobGroup
-
-		Returns:
-			This `JobGroup` object
-		"""
-
-		if isinstance(jobs, list):
-			self._jobs.extend(jobs)
-		else:
-			self._jobs.append(jobs)
-		return self
-
-	def start_all(self) -> Self:
-		"""
-		Start all jobs
-
-		Returns:
-			This `JobGroup` object
-		"""
-		for job in self._jobs:
-			job.start()
-		return self
-
-	def wait_all(self, timeout_ms: int | None = None) -> Self:
-		"""
-		Wait for all jobs to complete
-
-		Args:
-			timeout_ms:
-				Timeout in milliseconds
-		Returns:
-			This `JobGroup` object
-		"""
-		for job in self._jobs:
-			try:
-				if timeout_ms is None:
-					job.wait_for_state(JobStates.completed)
-				else:
-					job.wait_for_state(JobStates.completed, timeout_ms=timeout_ms)
-				job.refresh()
-			except Exception:
-				pass
-		return self
-
-	def incomplete_job_count(self) -> int:
-		"""
-		Returns the count of incomplete jobs
-
-		Returns:
-			Count of incomplete jobs
-		"""
-		return sum(1 for job in self._jobs if job.get_state() == JobStates.processing or JobStates.pending)
-
-	def jobs_with_error(self) -> list[Job]:
-		"""
-		Returns the list of jobs that produced errors
-
-		Returns:
-			List of jobs that produced errors
-		"""
-		return [job for job in self._jobs if job.get_state() == JobStates.error]
-
-	def remove(self, job_name: str) -> Self:
-		"""
-		Removes all jobs from the group whose name matches the provided name
-
-		Args:
-			job_name:
-				The name of the job(s) to be removed
-		Returns:
-			This `JobGroup` object
-		"""
-		self._jobs = [job for job in self._jobs if job.get_name() != job_name]
-		return self
-
-	def clear(self) -> Self:
-		"""
-		Removes all jobs from the group
-
-		Returns:
-			This `JobGroup` object
-		"""
-		self._jobs = []
-		return self
-
-	def get_jobs(self) -> list[Job]:
-		"""
-		Returns the list of jobs in the group
-
-		Returns:
-			List of jobs in the group
-		"""
-		return self._jobs
+    """
+    A wrapper class for a group of jobs for easier execution and waiting
+
+    Attributes:
+        _client:
+            The http client
+        _jobs:
+            List of jobs in the group
+    """
+
+    _client: httpx.Client
+
+    def __init__(self, client: httpx.Client):
+        self._jobs: list[Job] = []
+        self._client = client
+
+    @classmethod
+    def from_query_result(cls, client: httpx.Client, job_query_result: JobQueryResultHco) -> Self:
+        """
+        Initializes a `JobGroup` object from a JobQueryResultHco object
+        Args:
+            client: The http client
+            job_query_result: The JobQueryResultHco object whose jobs are to be added to the JobGroup
+
+        Returns:
+            The newly created `JobGroup` instance
+        """
+        instance = cls(client)
+        for job in job_query_result.iter_flat():
+            instance.add_jobs(Job.from_hco(instance._client, job))
+        return instance
+
+    def add_jobs(self, jobs: Union[Job, list[Job]]) -> Self:
+        """
+        Add a job or multiple jobs to the group
+
+        Args:
+            jobs: A job or a list of job objects to be added to the JobGroup
+
+        Returns:
+            This `JobGroup` object
+        """
+
+        if isinstance(jobs, list):
+            self._jobs.extend(jobs)
+        else:
+            self._jobs.append(jobs)
+        return self
+
+    def start_all(self) -> Self:
+        """
+        Start all jobs
+
+        Returns:
+            This `JobGroup` object
+        """
+        for job in self._jobs:
+            job.start()
+        return self
+
+    def wait_all(self, *, job_timeout_ms: int = 5000, total_timeout_ms: int | None = None) -> Self:
+        """
+        Wait for all jobs to complete or error state.
+        If the overall timeout elapses and some jobs are not complete, then exception.
+
+        Args:
+            job_timeout_ms:
+                Individual job timeout in milliseconds. Default is 5000 ms.
+            total_timeout_ms:
+                Timeout for the whole operation in milliseconds. Default is no timeout.
+        Returns:
+            This `JobGroup` object
+        """
+        start_time = time.time()
+        for job in self._jobs:
+            if total_timeout_ms is not None:
+                elapsed_time_ms = (time.time() - start_time) * 1000
+                if total_timeout_ms - elapsed_time_ms <= 0:
+                    raise Exception("Total timeout exceeded while waiting for jobs.")
+
+            try:
+                job.wait_for_state(JobStates.completed, timeout_ms=job_timeout_ms)
+            except Exception:
+                pass
+        return self
+
+    def all_jobs_completed_ok(self) -> bool:
+        for job in self._jobs:
+            state = job.get_state()
+            if state is not JobStates.completed:
+                return False
+        return True
+
+    def incomplete_jobs(self) -> list[Job]:
+        """
+        Returns the incomplete jobs
+
+        Returns:
+            Count of incomplete jobs
+        """
+        incomplete_jobs = []
+        for job in self._jobs:
+            state = job.get_state()
+            if state in (JobStates.processing, JobStates.pending):
+                incomplete_jobs.append(job)
+        return incomplete_jobs
+
+    def jobs_with_error(self) -> list[Job]:
+        """
+        Returns the list of jobs that produced errors
+
+        Returns:
+            List of jobs that produced errors
+        """
+        return [job for job in self._jobs if job.get_state() == JobStates.error]
+
+    def remove(self, job_name: str) -> Self:
+        """
+        Removes all jobs from the group whose name matches the provided name
+
+        Args:
+            job_name:
+                The name of the job(s) to be removed
+        Returns:
+            This `JobGroup` object
+        """
+        self._jobs = [job for job in self._jobs if job.get_name() != job_name]
+        return self
+
+    def clear(self) -> Self:
+        """
+        Removes all jobs from the group
+
+        Returns:
+            This `JobGroup` object
+        """
+        self._jobs = []
+        return self
+
+    def get_jobs(self) -> list[Job]:
+        """
+        Returns the list of jobs in the group
+
+        Returns:
+            List of jobs in the group
+        """
+        return self._jobs

pinexq_client/job_management/tool/processing_step.py

@@ -1,4 +1,4 @@
-from typing import Any, Self
+from typing import Any, Self, List, Optional
 
 import httpx
 from httpx import URL
@@ -6,7 +6,7 @@ from httpx import URL
 from pinexq_client.core import Link, MediaTypes
 from pinexq_client.core.hco.upload_action_hco import UploadParameters
 from pinexq_client.job_management.enterjma import enter_jma
-from pinexq_client.job_management.hcos import ProcessingStepHco, ProcessingStepLink
+from pinexq_client.job_management.hcos import ProcessingStepHco, ProcessingStepLink, ProcessingStepQueryResultHco
 from pinexq_client.job_management.hcos.entrypoint_hco import EntryPointHco
 from pinexq_client.job_management.hcos.job_hco import GenericProcessingConfigureParameters
 from pinexq_client.job_management.hcos.processingsteproot_hco import ProcessingStepsRootHco
@@ -14,7 +14,8 @@ from pinexq_client.job_management.known_relations import Relations
 from pinexq_client.job_management.model import (
     CreateProcessingStepParameters,
     EditProcessingStepParameters,
-    SetProcessingStepTagsParameters,
+    SetProcessingStepTagsParameters, ProcessingStepQueryParameters, ProcessingStepFilterParameter,
+    FunctionNameMatchTypes,
 )
 
 
@@ -37,20 +38,22 @@ class ProcessingStep:
         self._entrypoint = enter_jma(client)
         self._processing_steps_root = self._entrypoint.processing_step_root_link.navigate()
 
-    def create(self, title: str, function_name: str) -> Self:
+    def create(self, title: str, function_name: str, version: str = "0") -> Self:
         """
         Creates a new ProcessingStep by name.
 
         Args:
             title: Title of the ProcessingStep to be created
             function_name: Function name of the ProcessingStep to be created
+            version: Version of the ProcessingStep to be created
 
         Returns:
             The newly created ProcessingStep as `ProcessingStep` object
         """
         processing_step_hco = self._processing_steps_root.register_new_action.execute(CreateProcessingStepParameters(
             title=title,
-            function_name=function_name
+            function_name=function_name,
+            version=version
         ))
         self._processing_step = processing_step_hco
         return self
@@ -94,6 +97,81 @@ class ProcessingStep:
         processing_step_instance._get_by_link(ProcessingStepLink.from_link(client, link))
         return processing_step_instance
 
+    @classmethod
+    def from_name(cls, client: httpx.Client, step_name: str, version: str = "0") -> Self:
+        """Create a ProcessingStep object from an existing name.
+
+        Args:
+            client: Create a ProcessingStep object from an existing name.
+            step_name: Name of the registered processing step.
+            version: Version of the ProcessingStep to be created
+
+        Returns:
+            The newly created processing step as `ProcessingStep` object
+        """
+
+        # Attempt to find the processing step
+        query_result = cls._query_processing_steps(client, step_name, version)
+
+        # Check if exactly one result is found
+        if len(query_result.processing_steps) != 1:
+            # Attempt to suggest alternative steps if exact match not found
+            suggested_steps = cls._processing_steps_by_name(client, step_name)
+            raise NameError(
+                f"No processing step with the name {step_name} and version {version} registered. "
+                f"Suggestions: {suggested_steps}"
+            )
+
+        # Todo: For now we choose the first and only result. Make this more flexible?
+        processing_step_hco = query_result.processing_steps[0]
+        return ProcessingStep.from_hco(client, processing_step_hco)
+
+    @staticmethod
+    def _query_processing_steps(client: httpx.Client, step_name: str, version: Optional[str] = None) -> ProcessingStepQueryResultHco:
+        """
+        Helper function to query processing steps based on name and optional version.
+
+        Args:
+            client: HTTP client for executing queries.
+            step_name: Name of the processing step.
+            version: Optional version to match.
+
+        Returns:
+            Query result object containing the matching processing steps.
+        """
+        query_param = ProcessingStepQueryParameters(
+            filter=ProcessingStepFilterParameter(
+                function_name=step_name,
+                function_name_match_type=FunctionNameMatchTypes.match_exact,
+                version=version
+            )
+        )
+        instance = ProcessingStep(client)
+        return instance._processing_steps_root.query_action.execute(query_param)
+
+    @staticmethod
+    def _processing_steps_by_name(client: httpx.Client, step_name: str) -> list:
+        """
+        Suggest processing steps if the exact step is not found.
+
+        Args:
+            client: HTTP client for executing queries.
+            step_name: Name of the processing step.
+
+        Returns:
+            A list of alternative processing steps matching the step name.
+        """
+        # Query for steps without  version to get suggestions
+        instance = ProcessingStep(client)
+        query_result = instance._query_processing_steps(client, step_name)
+
+        # If no suggestions are found, raise an error
+        if len(query_result.processing_steps) == 0:
+            raise NameError(f"No processing steps found with the name '{step_name}'.")
+
+        # Return list of alternative steps as suggestions
+        return [f"{step.function_name}:{step.version}" for step in query_result.processing_steps]
+
     def refresh(self) -> Self:
         """Updates the processing step from the server
 

{pinexq_client-0.4.0.2024.717.1.dist-info → pinexq_client-0.4.2.20241009.1.dist-info}/METADATA

@@ -1,8 +1,8 @@
 Metadata-Version: 2.1
 Name: pinexq-client
-Version: 0.4.0.2024.717.1
+Version: 0.4.2.20241009.1
 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>, Pratik Poudel <poudel@data-cybernetics.com>
+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>
 License: MIT
 Requires-Python: >=3.11

{pinexq_client-0.4.0.2024.717.1.dist-info → pinexq_client-0.4.2.20241009.1.dist-info}/RECORD

@@ -1,6 +1,7 @@
-pinexq_client-0.4.0.2024.717.1.dist-info/METADATA,sha256=OLMe4REjxNJ2cpLLjBKzXbCDaCX4pprGqBz3ynSyo7s,3236
-pinexq_client-0.4.0.2024.717.1.dist-info/WHEEL,sha256=rSwsxJWe3vzyR5HCwjWXQruDgschpei4h_giTm0dJVE,90
-pinexq_client-0.4.0.2024.717.1.dist-info/licenses/LICENSE,sha256=3oz3tAhM7kOgRukkRe7wmh5T_HihZY77ZtJDJm91ZN8,1072
+pinexq_client-0.4.2.20241009.1.dist-info/METADATA,sha256=OwWRTY8LrZ0sTtVPcvKWudbDLVg_25sdw9B8inJczfc,3278
+pinexq_client-0.4.2.20241009.1.dist-info/WHEEL,sha256=Vza3XR51HW1KmFP0iIMUVYIvz0uQuKJpIXKYOBGQyFQ,90
+pinexq_client-0.4.2.20241009.1.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
+pinexq_client-0.4.2.20241009.1.dist-info/licenses/LICENSE,sha256=3oz3tAhM7kOgRukkRe7wmh5T_HihZY77ZtJDJm91ZN8,1072
 pinexq_client/core/__init__.py,sha256=8SVD_PRgJtpUCOtVjdR6fRrv6KPNk7HD6UQrn0FKR04,235
 pinexq_client/core/base_relations.py,sha256=oIUS58pkbMDdqm-3YOdsenhL1smtzeAk4fp7-U595MY,162
 pinexq_client/core/enterapi.py,sha256=sL9TmF1L5LaDJnre1l_tiHDUo9vTbZ8cvPSov3Q1UTs,671
@@ -20,7 +21,7 @@ pinexq_client/core/model/error.py,sha256=FNJrXVTkVnh6oDkHHc3sSZ2wNtEPCZyqgzZT01M
 pinexq_client/core/model/sirenmodels.py,sha256=vGRQlhM2cSa2caxQel91Jr48KWqM-vMYX32iaQCzIds,5547
 pinexq_client/core/polling.py,sha256=Z6VXn-PCGk4XX-4tQWZG59qJyCIS0eIrpPUORQDIGrs,1077
 pinexq_client/core/sirenaccess.py,sha256=5GDTolgIlt9rW2g9qG7LerUlmz0BQNKYGp78T2UPrv0,6771
-pinexq_client/job_management/__init__.py,sha256=BB5Bik_9rwjDLXCanYzEJgJuLJxwEeRqHH2rWvBdQFY,164
+pinexq_client/job_management/__init__.py,sha256=pvdID8cHtpXcjx-PKW9svc9DxMGG58cXyW-mhYEJPQE,164
 pinexq_client/job_management/enterjma.py,sha256=Ivl_jVPw_gaLyU5nKbywM-bbVGpn0MoCrZ0DMbJYf3s,1411
 pinexq_client/job_management/hcos/__init__.py,sha256=vMIdxGHBsVcKYKrVkCzD4a_VaheKSNxCimospFn5N88,396
 pinexq_client/job_management/hcos/entrypoint_hco.py,sha256=qodjAwO_MtawUuhmaYjhGXHV-uW1k94V9gKRYZRkhn4,2234
@@ -42,11 +43,11 @@ pinexq_client/job_management/hcos/workdata_used_tags_query_result_hco.py,sha256=
 pinexq_client/job_management/hcos/workdataroot_hco.py,sha256=LdEPW2JJTqAWi-6zj-40lfREhthcDL6nPXQk_nfMtCA,3936
 pinexq_client/job_management/known_relations.py,sha256=UlOF-sua8SyOPNNKzT_j6JVG8T-aewHIzn7S2ajXBhI,593
 pinexq_client/job_management/model/__init__.py,sha256=ApHhNfjx4bPuz10sQnyBA2zajYbU7loDTZSKC5H_jBY,34
-pinexq_client/job_management/model/open_api_generated.py,sha256=TwGg54yv55j3CCetXG9LXaukgFHVkSuBkyGfN1LtcbY,30212
+pinexq_client/job_management/model/open_api_generated.py,sha256=9VQtoenAmAVsRdR9GaQSBqrJIPrWFYkF5DKv8n9Z6Ow,30354
 pinexq_client/job_management/model/sirenentities.py,sha256=OInvxHpC6mnnYQjOMM2xAw7uLtvWwj9E2EQSRJe2jDo,3202
 pinexq_client/job_management/tool/__init__.py,sha256=58CRDcP8ifSx9eA2uyTLEg0_fX3FUuNUogY_lirx9AY,96
-pinexq_client/job_management/tool/job.py,sha256=ovDhx-xPbj2GrbseLsIofbXYYWyAuGxSjmUVgLoQrNE,22197
-pinexq_client/job_management/tool/job_group.py,sha256=c8huSZtwEFMY6gaMIfuw3zhZVCJeL-udU2q1qxa2iic,3016
-pinexq_client/job_management/tool/processing_step.py,sha256=A8IFemh0MRQUYlHzLhp0Ou4rlMv6OUiZYd4XXmscUfM,6337
+pinexq_client/job_management/tool/job.py,sha256=BA1S2NY6D4Cpa3Mmoly0M3qCzCiv6p-MP7_decSlP-0,22209
+pinexq_client/job_management/tool/job_group.py,sha256=4zW_SEbQMLVNqu_zLUP57epkypBbRc5gxjPLp_FZgZo,4515
+pinexq_client/job_management/tool/processing_step.py,sha256=0qq64JOESPFAgpUpmM9hWndh21BnCB95EExd21ZHYOg,9730
 pinexq_client/job_management/tool/workdata.py,sha256=8DwvzcjefKL-wBuCxy9ziaUC7gTf0TMXAa1WoCmHvZM,4903
-pinexq_client-0.4.0.2024.717.1.dist-info/RECORD,,
+pinexq_client-0.4.2.20241009.1.dist-info/RECORD,,

{pinexq_client-0.4.0.2024.717.1.dist-info → pinexq_client-0.4.2.20241009.1.dist-info}/WHEEL

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

pinexq_client-0.4.2.20241009.1.dist-info/entry_points.txt

@@ -0,0 +1,4 @@
+[console_scripts]
+
+[gui_scripts]
+