pinexq-client 0.5.0.20241018.1__py3-none-any.whl → 0.7.0.20241113.1__py3-none-any.whl

pinexq_client/core/hco/link_hco.py

@@ -2,10 +2,13 @@ from typing import Self, Type
 
 import httpx
 from httpx import URL
+from httpx import Response
 
-from pinexq_client.core import Link, Entity, navigate, ensure_siren_response, ClientException
+from pinexq_client.core import Link, Entity, navigate, ensure_siren_response, ClientException, raise_exception_on_error, \
+    ApiException
 from pinexq_client.core.hco.hco_base import ClientContainer, TEntity
 from pinexq_client.core.hco.unavailable import UnavailableLink, HypermediaAvailability
+from pinexq_client.core.model.error import ProblemDetails
 
 
 class LinkHco(ClientContainer, HypermediaAvailability):
@@ -51,6 +54,37 @@ class LinkHco(ClientContainer, HypermediaAvailability):
     def is_available() -> bool:
         return True
 
+    """Checks if the resource can be retrieved (no 404) """
+    def exists(self) -> bool:
+        response = navigate(self._client, self._link)
+        match response:
+            case Response() as r:
+                if r.status_code == 404:
+                    # resource is not found
+                    return False
+                elif r.status_code == 200:
+                    # resource found
+                    return True
+                elif r.status_code >= 400:
+                    raise_exception_on_error("Expected a resource or none, got error", r)
+                else:
+                    raise ApiException(f"Unexpected status code in response: {r.status_code}")
+
+            case ProblemDetails() as p:
+                if p.status == 404:
+                    # resource is not found
+                    return False
+                elif p.status == 200:
+                    # resource found
+                    return True
+                elif p.status >= 400:
+                    raise_exception_on_error("Expected a resource or none, got error", p)
+                else:
+                    raise ApiException(f"Unexpected status code in response: {p.status_code}")
+            case _:
+                # got entity
+                return True
+
     def _navigate_internal(self, parse_type: Type[TEntity] = Entity) -> TEntity:
         response = navigate(self._client, self._link, parse_type)
         return ensure_siren_response(response)
@@ -58,6 +92,13 @@ class LinkHco(ClientContainer, HypermediaAvailability):
     def get_url(self) -> URL:
         return URL(self._link.href)
 
+    def __eq__(self, other):
+        """Compares the link url to determine if the link is pointing to the same resource."""
+        if isinstance(other, LinkHco):
+            return self.get_url() == other.get_url()
+        else:
+            return NotImplemented
+
     def __repr__(self):
         rel_names = ', '.join((f"'{r}'" for r in self._link.rel))
         return f"<{self.__class__.__name__}: {rel_names}>"

pinexq_client/core/media_types.py

@@ -19,6 +19,9 @@ class MediaTypes(StrEnum):
     JPEG = "image/jpeg"
     BMP = "image/bmp"
 
+    WORKFLOW_DEFINITION = "application/vnd.pinexq.workflow.definition+json"
+    WORKFLOW_REPORT = "application/vnd.pinexq.workflow.report+json"
+
 
 class SirenClasses(StrEnum):
     FileUploadAction = "FileUploadAction"

pinexq_client/core/model/error.py

@@ -1,6 +1,6 @@
 from typing import Any
 
-from pydantic import BaseModel, Field, ConfigDict
+from pydantic import BaseModel
 
 
 class ProblemDetails(BaseModel):

pinexq_client/core/sirenaccess.py

@@ -43,12 +43,11 @@ def get_resource(client: httpx.Client, href: str, media_type: str = MediaTypes.S
         warnings.warn(f"Unexpected return code: {response.status_code}")
         return response
 
-
-def navigate(client: httpx.Client, link: Link,
+def navigate(client: httpx.Client,
+             link: Link,
              parse_type: type[TEntity] = Entity) -> TEntity | ProblemDetails | Response:
     return get_resource(client, link.href, link.type, parse_type)
 
-
 def ensure_siren_response(response: TEntity | ProblemDetails | Response) -> TEntity:
     raise_exception_on_error(f"Error while navigating, unexpected response", response)
     return response

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, 4]
+__jma_version__ = [7, 1, 0]

pinexq_client/job_management/hcos/jobsroot_hco.py

@@ -10,15 +10,15 @@ from pinexq_client.core.hco.link_hco import LinkHco
 from pinexq_client.core.hco.unavailable import UnavailableAction, UnavailableLink
 from pinexq_client.job_management.hcos.job_hco import JobLink
 from pinexq_client.job_management.hcos.job_query_result_hco import (
-	JobQueryResultHco,
-	JobQueryResultLink
+    JobQueryResultHco,
+    JobQueryResultLink
 )
 from pinexq_client.job_management.hcos.job_used_tags_hco import JobUsedTagsLink
 from pinexq_client.job_management.known_relations import Relations
 from pinexq_client.job_management.model.open_api_generated import (
-	CreateJobParameters,
-	JobQueryParameters,
-	CreateSubJobParameters, SetJobsErrorStateParameters
+    CreateJobParameters,
+    JobQueryParameters,
+    CreateSubJobParameters
 )
 from pinexq_client.job_management.model.sirenentities import JobsRootEntity
 
@@ -54,23 +54,11 @@ class JobQueryAction(ActionWithParametersHco):
         return self._get_default_parameters(JobQueryParameters, JobQueryParameters())
 
 
-class JobSetToErrorStateAction(ActionWithParametersHco[SetJobsErrorStateParameters]):
-    def execute(self, parameters: SetJobsErrorStateParameters):
-        self._execute(parameters)
-
-    def default_parameters(self) -> SetJobsErrorStateParameters:
-        return self._get_default_parameters(SetJobsErrorStateParameters, SetJobsErrorStateParameters(
-            message='Manually set to error state by admin',
-            created_this_many_hours_ago=0,
-        ))
-
-
 class JobsRootHco(Hco[JobsRootEntity]):
     create_job_action: CreateJobAction | UnavailableAction
     job_query_action: JobQueryAction | UnavailableAction
     create_subjob_action: CreateSubJobAction | UnavailableAction
     used_tags_link: JobUsedTagsLink | UnavailableLink
-    set_jobs_to_error_state: JobSetToErrorStateAction | UnavailableAction
 
     self_link: 'JobsRootLink'
 
@@ -86,8 +74,6 @@ class JobsRootHco(Hco[JobsRootEntity]):
         instance.used_tags_link = JobUsedTagsLink.from_entity_optional(
             instance._client, instance._entity, Relations.USED_TAGS)
         instance.self_link = JobsRootLink.from_entity(instance._client, instance._entity, Relations.SELF)
-        instance.set_jobs_to_error_state = JobSetToErrorStateAction.from_entity_optional(instance._client, instance._entity,
-                                                                                "SetJobsToErrorState")
 
         return instance
 

pinexq_client/job_management/model/open_api_generated.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  openapi.json
-#   timestamp: 2024-10-18T08:23:13+00:00
+#   timestamp: 2024-11-04T09:06:44+00:00
 
 from __future__ import annotations
 
@@ -372,15 +372,6 @@ class SetJobTagsParameters(BaseModel):
     tags: List[str] = Field(..., alias='Tags')
 
 
-class SetJobsErrorStateParameters(BaseModel):
-    model_config = ConfigDict(
-        extra='allow',
-        populate_by_name=True,
-    )
-    message: constr(min_length=1) = Field(..., alias='Message')
-    created_before: AwareDatetime = Field(..., alias='CreatedBefore')
-
-
 class SetNameWorkDataParameters(BaseModel):
     model_config = ConfigDict(
         extra='allow',
@@ -653,6 +644,7 @@ class JobHtoOpenApiProperties(BaseModel):
     error_description: str | None = Field(None, alias='ErrorDescription')
     processing: ProcessingView | None = Field(None, alias='Processing')
     result: str | None = Field(None, alias='Result')
+    configured_parameters: str | None = Field(None, alias='ConfiguredParameters')
 
 
 class JobQueryResultHtoOpenApi(BaseModel):

pinexq_client/job_management/tool/job.py

@@ -60,8 +60,8 @@ class Job:
     _client: httpx.Client
     _entrypoint: EntryPointHco
     _jobs_root: JobsRootHco
-    _job: JobHco | None = None
     _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.
 
     def __init__(self, client: httpx.Client):
         """
@@ -93,21 +93,20 @@ class Job:
         return self
 
     def _get_by_link(self, job_link: JobLink):
-        self._job = job_link.navigate()
+        self.job_hco = job_link.navigate()
 
     @classmethod
-    def from_hco(cls, client: httpx.Client, job: JobHco) -> Self:
+    def from_hco(cls, job: JobHco) -> Self:
         """Initializes a `Job` object from an existing JobHco object.
 
         Args:
-            client: An httpx.Client instance initialized with the api-host-url as `base_url`
             job: The 'JobHco' to initialize this job from.
 
         Returns:
             The newly created job as `Job` object.
         """
-        job_instance = cls(client)
-        job_instance._job = job
+        job_instance = cls(job._client)
+        job_instance.job_hco = job
         return job_instance
 
     @classmethod
@@ -140,7 +139,8 @@ class Job:
         Returns:
             The newly created job as `Job` object
         """
-        parent_job_url = self._job.self_link.get_url()
+        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))
         )
@@ -154,7 +154,8 @@ class Job:
         Returns:
             This `Job` object, but with updated properties.
         """
-        self._job = self._job.self_link.navigate()
+        self._raise_if_no_hco()
+        self.job_hco = self.job_hco.self_link.navigate()
         return self
 
     def get_state(self) -> JobStates:
@@ -164,7 +165,7 @@ class Job:
             The current state of this `Job` from JobStates
         """
         self.refresh()
-        return self._job.state
+        return self.job_hco.state
 
     def get_name(self) -> str:
         """Returns the name of this job
@@ -173,7 +174,7 @@ class Job:
             The name of this `Job`
         """
         self.refresh()
-        return self._job.name
+        return self.job_hco.name
 
     def select_processing(
             self,
@@ -193,6 +194,7 @@ class Job:
         Returns:
             This `Job` object
         """
+        self._raise_if_no_hco()
         if sum(p is not None for p in [function_name, processing_step_link, processing_step_instance]) != 1:
             raise ValueError("Exactly one parameter must be provided")
 
@@ -220,7 +222,7 @@ class Job:
             # 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()
 
-        self._job.select_processing_action.execute(
+        self.job_hco.select_processing_action.execute(
             SelectProcessingParameters(processing_step_url=str(processing_url))
         )
 
@@ -238,7 +240,8 @@ class Job:
         Returns:
             This `Job` object
         """
-        self._job.configure_processing_action.execute(
+        self._raise_if_no_hco()
+        self.job_hco.configure_processing_action.execute(
             GenericProcessingConfigureParameters.model_validate(parameters)
         )
 
@@ -251,7 +254,8 @@ class Job:
         Returns:
             This `Job` object
         """
-        self._job.start_processing_action.execute()
+        self._raise_if_no_hco()
+        self.job_hco.start_processing_action.execute()
         self.refresh()
         return self
 
@@ -267,7 +271,7 @@ class Job:
         # TODO: return Sentinel or Exception on 'NotDoneYet'
         # TODO: handle return value equivalent to asyncio's Future objects
         self.refresh()
-        result = self._job.result
+        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:
@@ -284,12 +288,13 @@ class Job:
 
 
         """
+        self._raise_if_no_hco()
         try:
             wait_until(
                 condition=lambda: self.get_state() == state,
                 timeout_ms=timeout_ms,
                 timeout_message="Waiting for job completion",
-                error_condition=lambda: self._job.state == JobStates.error,
+                error_condition=lambda: self.job_hco.state == JobStates.error,
                 polling_interval_ms=polling_interval_ms
             )
         except TimeoutError as timeout:
@@ -298,8 +303,8 @@ class Job:
                 f"current state: '{self.get_state().value}'. Error:{str(timeout)}"
             )
         except PollingException:
-            if self._job.state == JobStates.error:
-                error_reason = self._job.error_description
+            if self.job_hco.state == JobStates.error:
+                error_reason = self.job_hco.error_description
                 raise PollingException(f"Job failed'. Error:{error_reason}")
             raise PollingException("Job failed")
 
@@ -322,6 +327,7 @@ class Job:
         Returns:
             This `Job` object
         """
+        self._raise_if_no_hco()
         if sum(p is not None for p in [work_data_link, work_data_instance]) != 1:
             raise ValueError("Exactly one parameter must be provided")
 
@@ -334,7 +340,7 @@ class Job:
                 raise Exception('Instance passed to "work_data_link" is not of type "WorkDataLink"')
             work_data = work_data_link
 
-        dataslot = self._job.input_dataslots[index]
+        dataslot = self.job_hco.input_dataslots[index]
         dataslot.select_workdata_action.execute(
             parameters=SelectWorkDataForDataSlotParameters(
                 work_data_url=str(work_data.get_url())
@@ -361,6 +367,7 @@ class Job:
         Returns:
             This `Job` object
         """
+        self._raise_if_no_hco()
         if sum(p is not None for p in [work_data_links, work_data_instances]) != 1:
             raise ValueError("Exactly one parameter must be provided")
 
@@ -374,7 +381,7 @@ class Job:
                 raise Exception('Instance passed to "work_data_links" is not of type "list[WorkDataLink]"')
             work_datas = work_data_links
 
-        dataslot = self._job.input_dataslots[index]
+        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]
@@ -393,7 +400,8 @@ class Job:
         Returns:
             This `Job` object
         """
-        dataslot = self._job.input_dataslots[index]
+        self._raise_if_no_hco()
+        dataslot = self.job_hco.input_dataslots[index]
 
         # already cleared
         if not dataslot.clear_workdata_action:
@@ -412,14 +420,16 @@ class Job:
             show_deleted: bool | None = None,
             processing_step_url: str | None = None,
     ) -> JobQueryResultHco:
+        self._raise_if_no_hco()
         filter_param = JobFilterParameter(
             is_sub_job=True,
-            parent_job_url=str(self._job.self_link.get_url()),
+            parent_job_url=str(self.job_hco.self_link.get_url()),
             state=state,
             name=name,
             show_deleted=show_deleted,
             processing_step_url=processing_step_url,
         )
+
         query_param = JobQueryParameters(sort_by=sort_by, filter=filter_param)
         job_query_result = self._jobs_root.job_query_action.execute(query_param)
         return job_query_result
@@ -479,7 +489,8 @@ class Job:
         Returns:
             This `Job` object
         """
-        self._job.hide_action.execute()
+        self._raise_if_no_hco()
+        self.job_hco.hide_action.execute()
         self.refresh()
         return self
 
@@ -489,7 +500,9 @@ class Job:
         Returns:
             This `Job` object
         """
-        self._job.delete_action.execute()
+        self._raise_if_no_hco()
+        self.job_hco.delete_action.execute()
+        self.job_hco = None
         return self
 
     def delete_with_associated(
@@ -499,7 +512,7 @@ class Job:
             delete_input_workdata: bool = False,
             delete_subjobs_with_data: bool = True
     ) -> Self:
-        """Delete this job after deleting output workdata and subjobs depending on the flag.
+        """Delete this job after deleting output workdata and subjobs (recursive call) depending on the flag.
         Afterward, also deletes input workdata depending on the flag. This is a best effort operation,
         if an operation can not be executed a warning will be printed but the process continues.
 
@@ -511,22 +524,34 @@ class Job:
         Returns:
             This `Job` object
         """
+        self._raise_if_no_hco()
 
         # delete subjobs
         if delete_subjobs_with_data is True:
             for subjob in self._get_sub_jobs().iter_flat():
                 try:
-                    subjob.delete_action.execute()
+                    # recursion
+                    subjob_wrapper = Job.from_hco(subjob)
+                    subjob_wrapper.delete_with_associated(
+                        delete_output_workdata=delete_output_workdata,
+                        delete_input_workdata=delete_input_workdata,
+                        delete_subjobs_with_data=delete_subjobs_with_data)
+                    if subjob.self_link.exists():
+                        warnings.warn(f"Could not delete subjob: {subjob.self_link.get_url()}")
                 except (ClientException, ApiException) as e:
                     warnings.warn(f"Could not delete subjob: {subjob.self_link.get_url()}\n{e}")
                     pass
+        self.refresh()
 
         # delete output workdatas
         if delete_output_workdata is True:
-            for slot in self._job.output_dataslots:
+            for slot in self.job_hco.output_dataslots:
                 for wd in slot.assigned_workdatas:
                     try:
-                        wd.delete_action.execute()
+                        if wd.delete_action.is_available():
+                            wd.delete_action.execute()
+                        else:
+                            warnings.warn(f"Could not delete output workdata: {wd.self_link.get_url()}")
                     except (ClientException, ApiException) as e:
                         warnings.warn(f"Could not delete output workdata: {wd.self_link.get_url()}\n{e}")
                         pass
@@ -534,23 +559,35 @@ class Job:
         # delete this job
         self.refresh()
 
+        job_was_deleted = False
         try:
-            self.delete()
+            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
+
+            else:
+                warnings.warn(f"Could not delete job: {self.self_link().get_url()}")
         except (ClientException, ApiException) as e:
             warnings.warn(f"Could not delete job: {self.self_link().get_url()}\n{e}")
 
         # finally delete input workdatas
         if delete_input_workdata is True:
-            for slot in self._job.input_dataslots:
+            for slot in self.job_hco.input_dataslots:
                 for wd in slot.selected_workdatas:
                     try:
-                        wd.allow_deletion_action.execute()
                         wd = wd.self_link.navigate()
-                        wd.delete_action.execute()
+                        if wd.delete_action.is_available():
+                            wd.delete_action.execute()
+                        else:
+                            warnings.warn(f"Could not delete input workdata: {wd.self_link.get_url()}")
                     except (ClientException, ApiException) as e:
                         warnings.warn(f"Could not delete input workdata: {wd.self_link.get_url()}\n{e}")
                         pass
 
+        # we are done with the hco, set to none now since the resource was deleted. The wrapper makes no sense anymore
+        if job_was_deleted:
+            self.job_hco = None
         return self
 
     def unhide(self) -> Self:
@@ -559,7 +596,8 @@ class Job:
         Returns:
             This `Job` object
         """
-        self._job.unhide_action.execute()
+        self._raise_if_no_hco()
+        self.job_hco.unhide_action.execute()
         self.refresh()
         return self
 
@@ -569,7 +607,8 @@ class Job:
         Returns:
             This `Job` object
         """
-        self._job.allow_output_data_deletion_action.execute()
+        self._raise_if_no_hco()
+        self.job_hco.allow_output_data_deletion_action.execute()
         self.refresh()
         return self
 
@@ -579,7 +618,8 @@ class Job:
         Returns:
             This `Job` object
         """
-        self._job.disallow_output_data_deletion_action.execute()
+        self._raise_if_no_hco()
+        self.job_hco.disallow_output_data_deletion_action.execute()
         self.refresh()
         return self
 
@@ -589,7 +629,8 @@ class Job:
         Returns:
             This `Job` object
         """
-        self._job.edit_tags_action.execute(
+        self._raise_if_no_hco()
+        self.job_hco.edit_tags_action.execute(
             SetJobTagsParameters(tags=tags)
         )
         self.refresh()
@@ -601,7 +642,8 @@ class Job:
         Returns:
             `list[InputDataSlotHco]` object
         """
-        return self._job.input_dataslots
+        self._raise_if_no_hco()
+        return self.job_hco.input_dataslots
 
     def get_output_data_slots(self) -> list[OutputDataSlotHco]:
         """Returns list of OutputDataSlotHco objects.
@@ -609,13 +651,16 @@ class Job:
         Returns:
             `list[OutputDataSlotHco]` object
         """
-        return self._job.output_dataslots
+        self._raise_if_no_hco()
+        return self.job_hco.output_dataslots
 
     def get_processing_info(self) -> ProcessingView:
-        return self._job.processing
+        self._raise_if_no_hco()
+        return self.job_hco.processing
 
     def self_link(self) -> JobLink:
-        return self._job.self_link
+        self._raise_if_no_hco()
+        return self.job_hco.self_link
 
     def set_to_error_state(self) -> Self:
         """Set this job to error state.
@@ -623,5 +668,10 @@ class Job:
         Returns:
             This `Job` object
         """
-        self._job.set_to_error_state_action.execute()
+        self._raise_if_no_hco()
+        self.job_hco.set_to_error_state_action.execute()
         return self
+
+    def _raise_if_no_hco(self):
+        if self.job_hco is None:
+            raise Exception("No job hco present. Maybe this class is used after resource deletion.")

pinexq_client/job_management/tool/job_group.py

@@ -38,7 +38,7 @@ class JobGroup:
         """
         instance = cls(client)
         for job in job_query_result.iter_flat():
-            instance.add_jobs(Job.from_hco(instance._client, job))
+            instance.add_jobs(Job.from_hco(job))
         return instance
 
     def add_jobs(self, jobs: Union[Job, list[Job]]) -> Self:
@@ -125,17 +125,29 @@ class JobGroup:
         """
         return [job for job in self._jobs if job.get_state() == JobStates.error]
 
-    def remove(self, job_name: str) -> Self:
+    def remove(self, jobs: Job | list[Job]) -> Self:
         """
-        Removes all jobs from the group whose name matches the provided name
+        Removes given job(s) from the group
 
         Args:
-            job_name:
-                The name of the job(s) to be removed
+            jobs:
+                The Job instance(s) to be removed
         Returns:
             This `JobGroup` object
         """
-        self._jobs = [job for job in self._jobs if job.get_name() != job_name]
+
+        def remove_by_url(job_url: str):
+            for existing_job in self._jobs:
+                if existing_job.self_link().get_url() == job_url:
+                    self._jobs.remove(existing_job)
+                    break
+
+        if isinstance(jobs, list):
+            for job in jobs:
+                remove_by_url(str(job.self_link().get_url()))
+        else:
+            remove_by_url(str(jobs.self_link().get_url()))
+
         return self
 
     def clear(self) -> Self:

pinexq_client/job_management/tool/processing_step.py

@@ -1,4 +1,4 @@
-from typing import Any, Self, List, Optional
+from typing import Any, Self, Optional
 
 import httpx
 from httpx import URL
@@ -26,7 +26,8 @@ class ProcessingStep:
     _client: httpx.Client
     _entrypoint: EntryPointHco
     _processing_steps_root: ProcessingStepsRootHco
-    _processing_step: ProcessingStepHco | None = None
+    processing_step_hco: ProcessingStepHco | 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):
         """
@@ -55,25 +56,24 @@ class ProcessingStep:
             function_name=function_name,
             version=version
         ))
-        self._processing_step = processing_step_hco
+        self.processing_step_hco = processing_step_hco
         return self
 
     def _get_by_link(self, processing_step_link: ProcessingStepLink):
-        self._processing_step = processing_step_link.navigate()
+        self.processing_step_hco = processing_step_link.navigate()
 
     @classmethod
-    def from_hco(cls, client: httpx.Client, processing_step: ProcessingStepHco) -> Self:
+    def from_hco(cls, processing_step: ProcessingStepHco) -> Self:
         """Initializes a `ProcessingStep` object from an existing ProcessingStepHco object.
 
         Args:
-            client: An httpx.Client instance initialized with the api-host-url as `base_url`
             processing_step: The 'ProcessingStepHco' to initialize this ProcessingStep from.
 
         Returns:
             The newly created processing step as `ProcessingStep` object.
         """
-        processing_step_instance = cls(client)
-        processing_step_instance._processing_step = processing_step
+        processing_step_instance = cls(processing_step._client)
+        processing_step_instance.processing_step_hco = processing_step
         return processing_step_instance
 
     @classmethod
@@ -124,7 +124,7 @@ class ProcessingStep:
 
         # 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)
+        return ProcessingStep.from_hco(processing_step_hco)
 
     @staticmethod
     def _query_processing_steps(client: httpx.Client, step_name: str, version: Optional[str] = None) -> ProcessingStepQueryResultHco:
@@ -178,7 +178,8 @@ class ProcessingStep:
         Returns:
             This `ProcessingStep` object, but with updated properties.
         """
-        self._processing_step = self._processing_step.self_link.navigate()
+        self._raise_if_no_hco()
+        self.processing_step_hco = self.processing_step_hco.self_link.navigate()
         return self
 
     def set_tags(self, tags: list[str]) -> Self:
@@ -186,7 +187,8 @@ class ProcessingStep:
 
         Returns:
             This `ProcessingStep` object"""
-        self._processing_step.edit_tags_action.execute(SetProcessingStepTagsParameters(
+        self._raise_if_no_hco()
+        self.processing_step_hco.edit_tags_action.execute(SetProcessingStepTagsParameters(
             tags=tags
         ))
         self.refresh()
@@ -203,7 +205,8 @@ class ProcessingStep:
 
         Returns:
             This `ProcessingStep` object"""
-        self._processing_step.edit_properties_action.execute(EditProcessingStepParameters(
+        self._raise_if_no_hco()
+        self.processing_step_hco.edit_properties_action.execute(EditProcessingStepParameters(
             title=new_title,
             function_name=new_function_name,
             is_public=is_public
@@ -221,7 +224,8 @@ class ProcessingStep:
         Returns:
             This `ProcessingStep` object
         """
-        self._processing_step.configure_default_parameters_action.execute(
+        self._raise_if_no_hco()
+        self.processing_step_hco.configure_default_parameters_action.execute(
             GenericProcessingConfigureParameters.model_validate(parameters)
         )
 
@@ -234,7 +238,8 @@ class ProcessingStep:
         Returns:
             This `ProcessingStep` object
         """
-        self._processing_step.clear_default_parameters_action.execute()
+        self._raise_if_no_hco()
+        self.processing_step_hco.clear_default_parameters_action.execute()
         self.refresh()
 
         return self
@@ -245,7 +250,8 @@ class ProcessingStep:
         Returns:
             This `ProcessingStep` object
         """
-        self._processing_step.upload_configuration_action.execute(
+        self._raise_if_no_hco()
+        self.processing_step_hco.upload_configuration_action.execute(
             UploadParameters(
                 filename="config.json",  # placeholder, jma does not care about filename
                 mediatype=MediaTypes.APPLICATION_JSON,
@@ -257,4 +263,9 @@ class ProcessingStep:
         return self
 
     def self_link(self) -> ProcessingStepLink:
-        return self._processing_step.self_link
+        self._raise_if_no_hco()
+        return self.processing_step_hco.self_link
+
+    def _raise_if_no_hco(self):
+        if self.processing_step_hco is None:
+            raise Exception("No processing step hco present. Maybe this class is used after resource deletion.")

pinexq_client/job_management/tool/workdata.py

@@ -20,7 +20,7 @@ class WorkData:
     _client: httpx.Client
     _entrypoint: EntryPointHco
     _work_data_root: WorkDataRootHco
-    _work_data: WorkDataHco | None = None
+    work_data_hco: WorkDataHco | 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):
         """
@@ -49,23 +49,23 @@ class WorkData:
         self._get_by_link(work_data_link)
         return self
 
-    def _get_by_link(self, processing_step_link: WorkDataLink):
-        self._work_data = processing_step_link.navigate()
+    def _get_by_link(self, work_data_link: WorkDataLink):
+        self.work_data_hco = work_data_link.navigate()
 
     @classmethod
-    def from_hco(cls, client: httpx.Client, work_data: WorkDataHco) -> Self:
+    def from_hco(cls, work_data_hco: WorkDataHco) -> Self:
         """Initializes a `WorkData` object from an existing WorkDataHco object.
 
         Args:
             client: An httpx.Client instance initialized with the api-host-url as `base_url`
-            work_data: The WorkDataHco to initialize this WorkData from.
+            work_data_hco: The WorkDataHco to initialize this WorkData from.
 
         Returns:
             The newly created work data as `WorkData` object.
         """
 
-        work_data_instance = cls(client)
-        work_data_instance._work_data = work_data
+        work_data_instance = cls(work_data_hco._client)
+        work_data_instance.work_data_hco = work_data_hco
         return work_data_instance
 
     @classmethod
@@ -95,7 +95,8 @@ class WorkData:
         Returns:
             This `WorkData` object, but with updated properties.
         """
-        self._work_data = self._work_data.self_link.navigate()
+        self._raise_if_no_hco()
+        self.work_data_hco = self.work_data_hco.self_link.navigate()
         return self
 
     def set_tags(self, tags: list[str]):
@@ -103,7 +104,8 @@ class WorkData:
 
         Returns:
             This `WorkData` object"""
-        self._work_data.edit_tags_action.execute(SetTagsWorkDataParameters(
+        self._raise_if_no_hco()
+        self.work_data_hco.edit_tags_action.execute(SetTagsWorkDataParameters(
             tags=tags
         ))
         self.refresh()
@@ -114,7 +116,8 @@ class WorkData:
 
         Returns:
             This `WorkData` object"""
-        self._work_data.allow_deletion_action.execute()
+        self._raise_if_no_hco()
+        self.work_data_hco.allow_deletion_action.execute()
         self.refresh()
         return self
 
@@ -123,7 +126,8 @@ class WorkData:
 
         Returns:
             This `WorkData` object"""
-        self._work_data.disallow_deletion_action.execute()
+        self._raise_if_no_hco()
+        self.work_data_hco.disallow_deletion_action.execute()
         self.refresh()
         return self
 
@@ -132,7 +136,8 @@ class WorkData:
 
         Returns:
             This `WorkData` object"""
-        self._work_data.hide_action.execute()
+        self._raise_if_no_hco()
+        self.work_data_hco.hide_action.execute()
         self.refresh()
         return self
 
@@ -141,7 +146,9 @@ class WorkData:
 
         Returns:
             This `WorkData` object"""
-        self._work_data.delete_action.execute()
+        self._raise_if_no_hco()
+        self.work_data_hco.delete_action.execute()
+        self.work_data_hco = None
         return self
 
     def download(self) -> bytes:
@@ -150,7 +157,13 @@ class WorkData:
         Returns:
             Downloaded WorkData in bytes
         """
-        return self._work_data.download_link.download()
+        self._raise_if_no_hco()
+        return self.work_data_hco.download_link.download()
 
     def self_link(self) -> WorkDataLink:
-        return self._work_data.self_link
+        self._raise_if_no_hco()
+        return self.work_data_hco.self_link
+
+    def _raise_if_no_hco(self):
+        if self.work_data_hco is None:
+            raise Exception("No work data hco present. Maybe this class is used after resource deletion.")

{pinexq_client-0.5.0.20241018.1.dist-info → pinexq_client-0.7.0.20241113.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pinexq-client
-Version: 0.5.0.20241018.1
+Version: 0.7.0.20241113.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>, 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.5.0.20241018.1.dist-info → pinexq_client-0.7.0.20241113.1.dist-info}/RECORD

@@ -1,7 +1,7 @@
-pinexq_client-0.5.0.20241018.1.dist-info/METADATA,sha256=iPZaVcmKxfXwSxywFo5dj9iyfOnBo_igmxoWRHo-PJU,3278
-pinexq_client-0.5.0.20241018.1.dist-info/WHEEL,sha256=pM0IBB6ZwH3nkEPhtcp50KvKNX-07jYtnb1g1m6Z4Co,90
-pinexq_client-0.5.0.20241018.1.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
-pinexq_client-0.5.0.20241018.1.dist-info/licenses/LICENSE,sha256=3oz3tAhM7kOgRukkRe7wmh5T_HihZY77ZtJDJm91ZN8,1072
+pinexq_client-0.7.0.20241113.1.dist-info/METADATA,sha256=5aTcxNIUNdX1Szxha37WAKXXSbG_jia6h84xiw2CEy8,3278
+pinexq_client-0.7.0.20241113.1.dist-info/WHEEL,sha256=thaaA2w1JzcGC48WYufAs8nrYZjJm8LqNfnXFOFyCC4,90
+pinexq_client-0.7.0.20241113.1.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
+pinexq_client-0.7.0.20241113.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
@@ -11,17 +11,17 @@ pinexq_client/core/hco/action_hco.py,sha256=6bWea-SkFjn52m5sYywkZeNOe74Nxmsvj338
 pinexq_client/core/hco/action_with_parameters_hco.py,sha256=qvtoqTfDHddxB0ALanWXNDobSpazCmK2_ulTuvax2A4,3280
 pinexq_client/core/hco/download_link_hco.py,sha256=_ijLtRfzy0qKG_QXpsWBZ8FJfp60o5Lw7QVv4_EpgPY,1335
 pinexq_client/core/hco/hco_base.py,sha256=NglQuS6p1EimgtIx55G8ngBDGXc4lzyq08jsXzztE1I,3367
-pinexq_client/core/hco/link_hco.py,sha256=LamrK6XyD6Gf_pl1tnNO_aIphPqcklPMjrxx8jx9HVw,2183
+pinexq_client/core/hco/link_hco.py,sha256=XUk8anEu4hJET0ytKooB7-2Ntuzfes1rQziYXRE6D40,3845
 pinexq_client/core/hco/unavailable.py,sha256=CBJN_YnQRPPTwYr-3MIXQIgYXIDLw9ozIM2TNo0uewY,942
 pinexq_client/core/hco/upload_action_hco.py,sha256=oOGw0Z_nx67CbqJ-QkQJbffdXajBgKmBAfSfFtyq8wk,4690
 pinexq_client/core/http_headers.py,sha256=tY4h3DKVDMkjw9DLFn57HdEnwR1NAixMF8Yjgy3gjQY,183
-pinexq_client/core/media_types.py,sha256=qU-Jd92H5HKczWDk51EstFHadO6A_QJL4lLXHRlfgjQ,600
+pinexq_client/core/media_types.py,sha256=GhrTEXqIb4vAM9Bl-i3WybYiL3T_Uy1Eu6hvLN7Oexc,745
 pinexq_client/core/model/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pinexq_client/core/model/error.py,sha256=MZHma9zCxcTCUp21KZeD22EXK0xhcrKWDQVTEk7WAn4,437
+pinexq_client/core/model/error.py,sha256=ZDbUlwsj7d8XPMolSSLTFwgs3RBLvOvgmlEtoBuon5Y,418
 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=moZQz2ujFsl8_WP_jfl8eM6lOzTHD6CK0dXBD8Wrg2g,6939
-pinexq_client/job_management/__init__.py,sha256=kvOmgq1qw5ksPm9tbEg1p1XiiZRrwsdKBEgDR_qsk08,164
+pinexq_client/core/sirenaccess.py,sha256=qopQKDfL1enJFb0Ja8UgsLMVOa0oBGy7PonhlV7YVBY,6950
+pinexq_client/job_management/__init__.py,sha256=pZ4G2mi6jqfKnUtcf9Mvrb0IpkmEvG2JDVXuYLyInnY,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
@@ -30,7 +30,7 @@ pinexq_client/job_management/hcos/input_dataslot_hco.py,sha256=SDflhyW8kjpcTUfKA
 pinexq_client/job_management/hcos/job_hco.py,sha256=CwF0eD07pd88iZPQUb_10iDtotiemy48BJ5exYN5gRc,8649
 pinexq_client/job_management/hcos/job_query_result_hco.py,sha256=I0G8YIlYDhTahLz8n06L8BywlcsMGNWUEsmEr4Sk0GU,3315
 pinexq_client/job_management/hcos/job_used_tags_hco.py,sha256=nys6E97NNXATdnvX6KZ46JR9qEb2lnqol9ZvJVEiNpQ,944
-pinexq_client/job_management/hcos/jobsroot_hco.py,sha256=_mHEw_gVvWDZ_LcD7T6zLajl-TrmS1x4ULrBk6AmknY,4637
+pinexq_client/job_management/hcos/jobsroot_hco.py,sha256=P8C5CaIEq_bkh6YgJBuQEp45Cc4fHuU5lYuWNdgtISY,3853
 pinexq_client/job_management/hcos/output_dataslot_hco.py,sha256=zxpo-fI9eHcp_pMKcf2l-gRoPHX1RzQO53auHMRB_T8,1549
 pinexq_client/job_management/hcos/processing_step_hco.py,sha256=MykmFssysIc8fIUoPyNOLEGLGQNoC4zFgjIAIjf0v7U,5190
 pinexq_client/job_management/hcos/processing_step_used_tags_hco.py,sha256=90-2IWlYTcYX62NzmAPnmcUCwMDhmMZyBrNs_G3yigs,1067
@@ -43,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=-7TWWzqSeaNld3w_a5sSQWAGZvqY6Oq5c-b_RkL9RrE,31137
+pinexq_client/job_management/model/open_api_generated.py,sha256=Bcdy60VZtRPFXj05z6NjWeopAZsBo48QkVBdxwqScmI,30946
 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=aUa03aZ8rYPJA1SPAbCmdYS65G1s2xIPC9kEhzEnw08,22427
-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.5.0.20241018.1.dist-info/RECORD,,
+pinexq_client/job_management/tool/job.py,sha256=_4HKeOAXsVx9f3DR-2E2Oyr3RqGqEb3Am4D1HwFh9JI,24795
+pinexq_client/job_management/tool/job_group.py,sha256=JyBKqtKAMpVXwdGaGKzh5IJOHgMk8zhK9b54jfvEHkk,4817
+pinexq_client/job_management/tool/processing_step.py,sha256=dM4IcNymFl9d7nbxWliFE7gLLxG4RFQ8B4w14lfF2Mc,10180
+pinexq_client/job_management/tool/workdata.py,sha256=wRy_yfFZUJDh-hoGUuAbQaRGtPysDmEOhLwD84Fgz04,5510
+pinexq_client-0.7.0.20241113.1.dist-info/RECORD,,

{pinexq_client-0.5.0.20241018.1.dist-info → pinexq_client-0.7.0.20241113.1.dist-info}/WHEEL

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