pinexq-client 0.9.2.20250908.48__py3-none-any.whl → 0.10.3rc1__py3-none-any.whl

pinexq_client/job_management/model/open_api_generated.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  openapi.json
-#   timestamp: 2025-09-02T12:55:12+00:00
+#   timestamp: 2025-12-01T17:37:49+00:00
 
 from __future__ import annotations
 
@@ -43,6 +43,18 @@ class AdminWorkDataQueryResultHtoOpenApiProperties(BaseModel):
     remaining_tags: List[str] | None = Field(None, alias='RemainingTags')
 
 
+class AssignCodeHashParameters(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+        populate_by_name=True,
+    )
+    code_hash: constr(min_length=1) = Field(
+        ...,
+        alias='CodeHash',
+        description='The code hash of the processing to be deployed',
+    )
+
+
 class CopyPsFromOrgToUserActionParameters(BaseModel):
     model_config = ConfigDict(
         extra='allow',
@@ -117,6 +129,30 @@ class DataSpecificationHto(BaseModel):
     max_slots: int | None = Field(None, alias='MaxSlots')
 
 
+class DeploymentResourcePresets(Enum):
+    small = 'Small'
+    medium = 'Medium'
+    large = 'Large'
+    x_large = 'XLarge'
+
+
+class DeploymentStates(Enum):
+    undefined = 'Undefined'
+    not_deployed = 'NotDeployed'
+    platform = 'Platform'
+    external = 'External'
+    platform_suspended = 'PlatformSuspended'
+    external_suspended = 'ExternalSuspended'
+
+
+class DeprecatePsActionParameters(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+        populate_by_name=True,
+    )
+    reason: str | None = Field(None, alias='Reason')
+
+
 class EditProcessingStepParameters(BaseModel):
     model_config = ConfigDict(
         extra='allow',
@@ -278,52 +314,9 @@ class ProcessingStepFilterParameter(BaseModel):
     tags_by_or: List[str] | None = Field(None, alias='TagsByOr')
     is_public: bool | None = Field(None, alias='IsPublic')
     show_hidden: bool | None = Field(None, alias='ShowHidden')
+    show_deprecated: bool | None = Field(None, alias='ShowDeprecated')
     is_configured: bool | None = Field(None, alias='IsConfigured')
-
-
-class ProcessingStepHtoOpenApiProperties(BaseModel):
-    model_config = ConfigDict(
-        extra='allow',
-        populate_by_name=True,
-    )
-    title: str | None = Field(None, alias='Title')
-    owner_id: str | None = Field(
-        None, alias='OwnerId', description='The owner of this resource'
-    )
-    created_by: str | None = Field(
-        None, alias='CreatedBy', description='The creator of this resource'
-    )
-    version: str | None = Field(
-        None, alias='Version', description='Version of the algorithm. Default = "0"'
-    )
-    function_name: str | None = Field(
-        None,
-        alias='FunctionName',
-        description='Unique name (possibly human readable) for the function so that it can be identified',
-    )
-    short_description: str | None = Field(
-        None, alias='ShortDescription', description='Human readable short description'
-    )
-    long_description: str | None = Field(
-        None, alias='LongDescription', description='Human readable long description'
-    )
-    has_parameters: bool | None = Field(None, alias='HasParameters')
-    is_public: bool | None = Field(None, alias='IsPublic')
-    tags: List[str] | None = Field(None, alias='Tags')
-    is_configured: bool | None = Field(None, alias='IsConfigured')
-    hidden: bool | None = Field(None, alias='Hidden')
-    created_at: AwareDatetime | None = Field(None, alias='CreatedAt')
-    last_modified_at: AwareDatetime | None = Field(None, alias='LastModifiedAt')
-    parameter_schema: str | None = Field(None, alias='ParameterSchema')
-    default_parameters: str | None = Field(None, alias='DefaultParameters')
-    return_schema: str | None = Field(None, alias='ReturnSchema')
-    error_schema: str | None = Field(None, alias='ErrorSchema')
-    input_data_slot_specification: List[DataSpecificationHto] | None = Field(
-        None, alias='InputDataSlotSpecification'
-    )
-    output_data_slot_specification: List[DataSpecificationHto] | None = Field(
-        None, alias='OutputDataSlotSpecification'
-    )
+    deployment_state: DeploymentStates | None = Field(None, alias='DeploymentState')
 
 
 class ProcessingStepQueryResultHtoOpenApiProperties(BaseModel):
@@ -409,6 +402,23 @@ class RenameJobParameters(BaseModel):
     new_name: constr(min_length=1) = Field(..., alias='NewName')
 
 
+class ScalingBehaviours(Enum):
+    aggressive = 'Aggressive'
+    balanced = 'Balanced'
+    conservative = 'Conservative'
+
+
+class ScalingConfiguration(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+        populate_by_name=True,
+    )
+    behaviour: ScalingBehaviours = Field(..., alias='Behaviour')
+    max_replicas: int = Field(
+        ..., alias='MaxReplicas', description='How many instances will run at most'
+    )
+
+
 class SelectProcessingParameters(BaseModel):
     model_config = ConfigDict(
         extra='allow',
@@ -625,7 +635,9 @@ class AdminProcessingStepFilterParameter(BaseModel):
     tags_by_or: List[str] | None = Field(None, alias='TagsByOr')
     is_public: bool | None = Field(None, alias='IsPublic')
     show_hidden: bool | None = Field(None, alias='ShowHidden')
+    show_deprecated: bool | None = Field(None, alias='ShowDeprecated')
     is_configured: bool | None = Field(None, alias='IsConfigured')
+    deployment_state: DeploymentStates | None = Field(None, alias='DeploymentState')
 
 
 class AdminProcessingStepQueryResultHtoOpenApi(BaseModel):
@@ -686,6 +698,20 @@ class AdminWorkDataQueryResultHtoOpenApi(BaseModel):
     links: List[Link] | None = None
 
 
+class ConfigureDeploymentParameters(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+        populate_by_name=True,
+    )
+    resource_preset: DeploymentResourcePresets = Field(..., alias='ResourcePreset')
+    entrypoint: constr(min_length=1) = Field(
+        ...,
+        alias='Entrypoint',
+        description='Specifies the container entry point, aka ProCon file to use',
+    )
+    scaling: ScalingConfiguration = Field(..., alias='Scaling')
+
+
 class EntryPointHtoOpenApi(BaseModel):
     model_config = ConfigDict(
         extra='allow',
@@ -814,17 +840,76 @@ class JobsRootHtoOpenApi(BaseModel):
     links: List[Link] | None = None
 
 
-class ProcessingStepHtoOpenApi(BaseModel):
+class ProcessingStepDeploymentHto(BaseModel):
+    """
+    Displays the deployment configuration
+    """
+
     model_config = ConfigDict(
         extra='allow',
         populate_by_name=True,
     )
-    class_: List[str] | None = Field(None, alias='class')
-    title: str | None = None
-    properties: ProcessingStepHtoOpenApiProperties | None = None
-    entities: List | None = None
-    actions: List[Action] | None = None
-    links: List[Link] | None = None
+    resource_preset: DeploymentResourcePresets | None = Field(
+        None, alias='ResourcePreset'
+    )
+    scaling_behaviour: ScalingBehaviours | None = Field(None, alias='ScalingBehaviour')
+    max_replicas: int | None = Field(None, alias='MaxReplicas')
+    entrypoint: str | None = Field(None, alias='Entrypoint')
+
+
+class ProcessingStepHtoOpenApiProperties(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+        populate_by_name=True,
+    )
+    title: str | None = Field(None, alias='Title')
+    owner_id: str | None = Field(
+        None, alias='OwnerId', description='The owner of this resource'
+    )
+    created_by: str | None = Field(
+        None, alias='CreatedBy', description='The creator of this resource'
+    )
+    version: str | None = Field(
+        None, alias='Version', description='Version of the algorithm. Default = "0"'
+    )
+    function_name: str | None = Field(
+        None,
+        alias='FunctionName',
+        description='Unique name (possibly human-readable) for the function so that it can be identified',
+    )
+    short_description: str | None = Field(
+        None, alias='ShortDescription', description='Human-readable short description'
+    )
+    long_description: str | None = Field(
+        None, alias='LongDescription', description='Human-readable long description'
+    )
+    code_hash: str | None = Field(
+        None,
+        alias='CodeHash',
+        description='The hash of the code executing this function. This is intended to inhibit\nredeployment of different code for the same function version.',
+    )
+    has_parameters: bool | None = Field(None, alias='HasParameters')
+    is_public: bool | None = Field(None, alias='IsPublic')
+    tags: List[str] | None = Field(None, alias='Tags')
+    is_configured: bool | None = Field(None, alias='IsConfigured')
+    hidden: bool | None = Field(None, alias='Hidden')
+    is_deprecated: bool | None = Field(None, alias='IsDeprecated')
+    deprecated_on: AwareDatetime | None = Field(None, alias='DeprecatedOn')
+    reason_for_deprecation: str | None = Field(None, alias='ReasonForDeprecation')
+    created_at: AwareDatetime | None = Field(None, alias='CreatedAt')
+    last_modified_at: AwareDatetime | None = Field(None, alias='LastModifiedAt')
+    parameter_schema: str | None = Field(None, alias='ParameterSchema')
+    default_parameters: str | None = Field(None, alias='DefaultParameters')
+    return_schema: str | None = Field(None, alias='ReturnSchema')
+    error_schema: str | None = Field(None, alias='ErrorSchema')
+    input_data_slot_specification: List[DataSpecificationHto] | None = Field(
+        None, alias='InputDataSlotSpecification'
+    )
+    output_data_slot_specification: List[DataSpecificationHto] | None = Field(
+        None, alias='OutputDataSlotSpecification'
+    )
+    deployment_state: DeploymentStates | None = Field(None, alias='DeploymentState')
+    deployment: ProcessingStepDeploymentHto | None = Field(None, alias='Deployment')
 
 
 class ProcessingStepQueryResultHtoOpenApi(BaseModel):
@@ -1057,6 +1142,19 @@ class JobQueryParameters(BaseModel):
     include_remaining_tags: bool | None = Field(None, alias='IncludeRemainingTags')
 
 
+class ProcessingStepHtoOpenApi(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+        populate_by_name=True,
+    )
+    class_: List[str] | None = Field(None, alias='class')
+    title: str | None = None
+    properties: ProcessingStepHtoOpenApiProperties | None = None
+    entities: List | None = None
+    actions: List[Action] | None = None
+    links: List[Link] | None = None
+
+
 class ProcessingStepQueryParameters(BaseModel):
     model_config = ConfigDict(
         extra='allow',

pinexq_client/job_management/tool/job.py

@@ -1,5 +1,9 @@
 import json as json_
 import warnings
+import queue
+import datetime
+from datetime import datetime, timedelta
+
 from typing import Any, Self, List
 
 import httpx
@@ -7,6 +11,7 @@ from httpx import URL
 from pydantic import BaseModel, ConfigDict
 
 from pinexq_client.core import Link, MediaTypes, ClientException, ApiException
+from pinexq_client.core.api_event_manager import ApiEventManagerSingleton
 from pinexq_client.core.polling import wait_until, PollingException
 from pinexq_client.job_management.enterjma import enter_jma
 from pinexq_client.job_management.hcos import WorkDataLink, ProcessingStepLink, InputDataSlotHco, OutputDataSlotHco
@@ -92,7 +97,7 @@ class Job:
         .select_processing(processing_step='job_processing')
         .configure_parameters(**job_parameters)
         .start()
-        .wait_for_state(JobStates.completed)
+        .wait_for_completion()
         .delete()
     )
     """
@@ -127,7 +132,7 @@ class Job:
             The newly created job as `Job` object
         """
         job_link = self._jobs_root.create_job_action.execute(
-            CreateJobParameters(name=name)
+            CreateJobParameters(Name=name)
         )
         self._get_by_link(job_link)
         return self
@@ -182,7 +187,7 @@ class Job:
         self._raise_if_no_hco()
         parent_job_url = self.job_hco.self_link.get_url()
         sub_job_link = self._jobs_root.create_subjob_action.execute(
-            CreateSubJobParameters(name=name, parent_job_url=str(parent_job_url))
+            CreateSubJobParameters(Name=name, ParentJobUrl=str(parent_job_url))
         )
         sub_job = Job(self._client)
         sub_job._get_by_link(sub_job_link)
@@ -256,10 +261,10 @@ class Job:
                 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(
-                    function_name=function_name,
-                    function_name_match_type=FunctionNameMatchTypes.match_exact,
-                    version=function_version
+                Filter=ProcessingStepFilterParameter(
+                    FunctionName=function_name,
+                    FunctionNameMatchType=FunctionNameMatchTypes.match_exact,
+                    Version=function_version
                 )
             )
             query_result = self._processing_step_root.query_action.execute(query_param)
@@ -271,7 +276,7 @@ class Job:
             processing_url = query_result.processing_steps[0].self_link.get_url()
 
         self.job_hco.select_processing_action.execute(
-            SelectProcessingParameters(processing_step_url=str(processing_url))
+            SelectProcessingParameters(ProcessingStepUrl=str(processing_url))
         )
 
         self.refresh()
@@ -322,13 +327,64 @@ class Job:
         result = self.job_hco.result
         return json_.loads(result) if result else None
 
-    def wait_for_state(self, state: JobStates, timeout_ms: int = 5000, polling_interval_ms: int = 1000) -> Self:
+    def wait_for_state_sse(self, state: JobStates, timeout_s: float | None = None, fallback_polling_interval_s: float = 300) -> Self:
+        self._raise_if_no_hco()
+
+        # early exit
+        if self.job_hco.state == state:
+            return self
+        if self.job_hco.state == JobStates.error:
+            error_reason = self.job_hco.error_description
+            raise PollingException(f"Job failed'. Error:{error_reason}")
+
+        if timeout_s is None:
+            function_timeout_on = datetime.max
+        else:
+            # end this wait hard
+            function_timeout_on = datetime.now() + timedelta(seconds=timeout_s)
+
+        job_changed_signal = queue.Queue()
+        manager = ApiEventManagerSingleton()
+        job_url_str = str(self.job_hco.self_link.get_url())
+        manager.subscribe_waiter(self._client, job_url_str, job_changed_signal)
+
+        try:
+            self.get_state()
+            job_done = self.job_hco.state == state
+            while not job_done:
+                time_till_function_timeout = function_timeout_on - datetime.now()
+                if time_till_function_timeout.total_seconds() <= 0.0:
+                    raise PollingException(f"Timeout waiting for Job state. Current state: {self.job_hco.state}")
+
+                next_wait_timeout_s = min(float(time_till_function_timeout.seconds), fallback_polling_interval_s)
+
+                try:
+                    job_changed_signal.get(timeout=next_wait_timeout_s)
+                except queue.Empty:
+                    # nothing we do just a poll and loop again
+                    pass
+
+                # read all messages since we only want to poll new state once if there are multiple messages
+                while not job_changed_signal.empty():
+                    job_changed_signal.get(timeout=next_wait_timeout_s)
+
+                self.get_state()
+                job_done = self.job_hco.state == state
+                if self.job_hco.state == JobStates.error:
+                    error_reason = self.job_hco.error_description
+                    raise PollingException(f"Job failed'. Error:{error_reason}")
+        finally:
+            manager.unsubscribe_waiter(self._client, job_url_str, job_changed_signal)
+
+        return self
+
+    def wait_for_state(self, state: JobStates, timeout_s: float | None = None, polling_interval_s: float = 1) -> Self:
         """Wait for this job to reach a state. If the job enters error state an exception is risen
 
         Args:
             state: The state to wait for. After the job enters this state this function returns.
-            timeout_ms: Time span in milliseconds to wait for reaching the state before raising an exception.
-            polling_interval_ms: will determine how fast the API is polled for updates.
+            timeout_s: Time span in seconds to wait for reaching the state before raising an exception.
+            polling_interval_s: will determine how fast the API is polled for updates.
             Note that low values will produce unnecessary load.
 
         Returns:
@@ -340,10 +396,10 @@ class Job:
         try:
             wait_until(
                 condition=lambda: self.get_state() == state,
-                timeout_ms=timeout_ms,
+                timeout_ms= int(timeout_s * 1000) if timeout_s is not None else None,
                 timeout_message="Waiting for job completion",
                 error_condition=lambda: self.job_hco.state == JobStates.error,
-                polling_interval_ms=polling_interval_ms
+                polling_interval_ms= int(polling_interval_s * 1000)
             )
         except TimeoutError as timeout:
             raise TimeoutError(
@@ -358,18 +414,17 @@ class Job:
 
         return self
 
-    def wait_for_completion(self, timeout_ms: int = 60000, polling_interval_ms: int = 500) -> Self:
+    def wait_for_completion(self, timeout_s: float | None = None) -> 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.
+            timeout_s: Timeout to wait for the job to reach the next state.
             Note that low values will produce unnecessary load.
 
         Returns:
             This `Job` object
         """
-        return self.wait_for_state(JobStates.completed, timeout_ms, polling_interval_ms)
+        return self.wait_for_state_sse(JobStates.completed, timeout_s)
 
     def assign_input_dataslot(
             self,
@@ -404,7 +459,7 @@ class Job:
         dataslot = self.job_hco.input_dataslots[index]
         dataslot.select_workdata_action.execute(
             parameters=SelectWorkDataForDataSlotParameters(
-                work_data_url=str(work_data.get_url())
+                WorkDataUrl=str(work_data.get_url())
             )
         )
         self.refresh()
@@ -445,7 +500,7 @@ class Job:
         dataslot = self.job_hco.input_dataslots[index]
         dataslot.select_workdata_collection_action.execute(
             parameters=SelectWorkDataCollectionForDataSlotParameters(
-                work_data_urls=[str(workdata_link.get_url()) for workdata_link in work_datas]
+                WorkDataUrls=[str(workdata_link.get_url()) for workdata_link in work_datas]
             )
         )
         self.refresh()
@@ -483,15 +538,15 @@ class Job:
     ) -> JobQueryResultHco:
         self._raise_if_no_hco()
         filter_param = JobFilterParameter(
-            is_sub_job=True,
-            parent_job_url=str(self.job_hco.self_link.get_url()),
-            state=state,
-            name=name,
+            IsSubJob=True,
+            ParentJobUrl=str(self.job_hco.self_link.get_url()),
+            State=state,
+            Name=name,
             show_deleted=show_deleted,
-            processing_step_url=processing_step_url,
+            ProcessingStepUrl=processing_step_url,
         )
 
-        query_param = JobQueryParameters(sort_by=sort_by, filter=filter_param)
+        query_param = JobQueryParameters(SortBy=sort_by, Filter=filter_param)
         job_query_result = self._jobs_root.job_query_action.execute(query_param)
         return job_query_result
 
@@ -511,32 +566,32 @@ class Job:
         query_result = self._get_sub_jobs(state=state)
         return query_result.total_entities
 
-    def wait_for_sub_jobs_complete(self, timeout_ms: int = 60000, polling_interval_ms: int = 1000) -> Self:
+    def wait_for_sub_jobs_complete(self, timeout_s: float = 60, polling_interval_s: float = 1) -> Self:
         """Wait for all sub-jobs to reach the state 'completed'.
 
         This function will block execution until the state is reached or raise an exception
         if the operation timed out or a sub-job returned an error. Only started jobs will be watched.
 
         Args:
-            timeout_ms: Timeout to wait for the sub-jobs to reach the next state.
+            timeout_s: Timeout to wait for the sub-jobs to reach the next state.
 
         Returns:
             This `Job` object
-            :param timeout_ms: Wil determine how long to wait for success
-            :param polling_interval_ms: will determine how fast the API is polled for updates.
+            :param timeout_s: Wil determine how long to wait for success
+            :param polling_interval_s: will determine how fast the API is polled for updates.
             Note that low values will produce unnecessary load.
         """
         wait_until(
             condition=lambda: self.sub_jobs_in_state(JobStates.pending) == 0,
-            timeout_ms=timeout_ms,
-            timeout_message=f"Timeout while waiting for sub-jobs to complete! [timeout: {timeout_ms}ms]",
-            polling_interval_ms=polling_interval_ms
+            timeout_ms= int(timeout_s * 1000),
+            timeout_message=f"Timeout while waiting for sub-jobs to complete! [timeout: {timeout_s}s]",
+            polling_interval_ms= int(polling_interval_s * 1000)
         )
         wait_until(
             condition=lambda: self.sub_jobs_in_state(JobStates.processing) == 0,
-            timeout_ms=timeout_ms,
-            timeout_message=f"Timeout while waiting for sub-jobs to complete! [timeout: {timeout_ms}ms]",
-            polling_interval_ms=polling_interval_ms
+            timeout_ms= int(timeout_s * 1000),
+            timeout_message=f"Timeout while waiting for sub-jobs to complete! [timeout: {timeout_s}ms]",
+            polling_interval_ms= int(polling_interval_s * 1000)
         )
 
         error_count = self.sub_jobs_in_state(JobStates.error)
@@ -633,7 +688,7 @@ class Job:
             warnings.warn(f"Could not delete job: {self.self_link().get_url()}\n{e}")
 
         # finally delete input workdatas
-        if delete_input_workdata is True:
+        if delete_input_workdata:
             for slot in self.job_hco.input_dataslots:
                 for wd in slot.selected_workdatas:
                     try:
@@ -692,7 +747,7 @@ class Job:
         """
         self._raise_if_no_hco()
         self.job_hco.edit_tags_action.execute(
-            SetJobTagsParameters(tags=tags)
+            SetJobTagsParameters(Tags=tags)
         )
         self.refresh()
         return self
@@ -730,14 +785,23 @@ class Job:
             processing_step_instance: ProcessingStep | None = None,
             start: bool = True,
             parameters: str | None = None,
-            allow_output_data_slots: bool | None = None,
+            allow_output_data_deletion: bool | None = None,
             input_data_slots: List[InputDataSlotParameterFlexible] | None = None,
     ) -> Self:
         """
         Creates a new job and configures it rapidly with RapidJobSetupParameters.
 
         Args:
-            parameters: The parameters to configure the job with.
+            name: Name of the job to be created
+            parent_job_url: URL of the parent job as JobLink. Only one of parent_job_url or parent_job_instance must be provided.
+            parent_job_instance: Parent job as Job instance. Only one of parent_job_url or parent_job_instance must be provided.
+            tags: Tags to assign to the job
+            processing_step_url: URL of the processing step as ProcessingStepLink. Only one of processing_step_url or processing_step_instance must be provided.
+            processing_step_instance: Processing step as ProcessingStep instance. Only one of processing_step_url or processing_step_instance must be provided.
+            start: Flag indicating whether to start the job after creation
+            parameters: Input parameters to the job
+            allow_output_data_deletion: Flag indicating whether to allow output data deletion
+            input_data_slots: List of InputDataSlotParameterFlexible to assign work data to input data slots
 
         Returns:
             The newly created job as `Job` object
@@ -785,7 +849,7 @@ class Job:
             Tags=tags,
             Start=start,
             Parameters=parameters,
-            AllowOutputDataDeletion=allow_output_data_slots,
+            AllowOutputDataDeletion=allow_output_data_deletion,
             InputDataSlots=input_data_slots
         )