pinexq-client 1.0.0__py3-none-any.whl → 1.2.0__py3-none-any.whl

pinexq/client/job_management/__init__.py

@@ -19,7 +19,7 @@ from .hcos import (
 )
 from .known_relations import Relations
 from .model import JobSortPropertiesSortParameter, ProcessingView
-from .tool import Job, JobGroup, ProcessingStep, WorkData
+from .tool import Job, JobGroup, JobQuery, ProcessingStep, ProcessingStepQuery, WorkData, WorkDataQuery
 
 # Protocol version the JMA is using
-__jma_version__ = [9, 1, 0]
+__jma_version__ = [9, 3, 0]

pinexq/client/job_management/hcos/job_hco.py

@@ -17,7 +17,7 @@ from ..model.open_api_generated import (
     ProcessingView,
     RenameJobParameters,
     SelectProcessingParameters,
-    SetJobTagsParameters,
+    SetJobTagsParameters, TagDetailsHto,
 )
 from ..model.sirenentities import InputDataSlotEntity, JobEntity, OutputDataSlotEntity
 
@@ -121,6 +121,7 @@ class JobHco(Hco[JobEntity]):
     state: JobStates = Property()
     hidden: bool = Property()
     tags: list[str] | None = Property()
+    tag_details: List[TagDetailsHto] | None = Property()
     output_is_deletable: bool = Property()
     created_at: datetime = Property()
     started_at: datetime = Property()

pinexq/client/job_management/hcos/processing_step_hco.py

@@ -23,7 +23,7 @@ from ..model.open_api_generated import (
     DataSpecificationHto,
     DeploymentStates,
     ProcessingStepDeploymentHto,
-    SetProcessingStepTagsParameters, SetProcessingStepTitleParameters,
+    SetProcessingStepTagsParameters, SetProcessingStepTitleParameters, TagDetailsHto,
 )
 from ..model.sirenentities import ProcessingStepEntity
 
@@ -181,6 +181,7 @@ class ProcessingStepHco(Hco[ProcessingStepEntity]):
     owner_id: str | None= Property()
 
     tags: list[str] | None = Property()
+    tag_details: List[TagDetailsHto] | None = Property()
     has_parameters: bool | None = Property()
     is_public: bool | None = Property()
     created_at: datetime | None = Property()

pinexq/client/job_management/hcos/workdata_hco.py

@@ -1,5 +1,5 @@
 from datetime import datetime
-from typing import Self
+from typing import Self, List
 
 import httpx
 
@@ -18,7 +18,7 @@ from ..model.open_api_generated import (
     SetCommentWorkDataParameters,
     SetNameWorkDataParameters,
     SetTagsWorkDataParameters,
-    WorkDataKind,
+    WorkDataKind, TagDetailsHto,
 )
 from ..model.sirenentities import WorkDataEntity
 
@@ -100,6 +100,7 @@ class WorkDataHco(Hco[WorkDataEntity]):
     created_at: datetime | None = Property()
     size_in_bytes: int | None = Property()
     tags: list[str] | None = Property()
+    tag_details: List[TagDetailsHto] | None = Property()
     media_type: str | None = Property()
     kind: WorkDataKind | None = Property()
     comments: str | None = Property()

pinexq/client/job_management/model/open_api_generated.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  openapi.json
-#   timestamp: 2026-01-20T12:34:19+00:00
+#   timestamp: 2026-02-03T21:15:10+00:00
 
 from __future__ import annotations
 
@@ -119,6 +119,8 @@ class DeploymentResourcePresets(StrEnum):
     medium = 'Medium'
     large = 'Large'
     x_large = 'XLarge'
+    xx_large = 'XXLarge'
+    x_small = 'XSmall'
 
 
 class DeploymentStates(StrEnum):
@@ -508,6 +510,17 @@ class SuspendAllDeploymentsParameters(BaseModel):
     suspension_type: DeploymentSuspensionTypes = Field(..., alias='SuspensionType')
 
 
+class TagValueTypes(StrEnum):
+    key_only = 'KeyOnly'
+    string = 'String'
+    integer = 'Integer'
+    float = 'Float'
+    boolean = 'Boolean'
+    date = 'Date'
+    time = 'Time'
+    timestamp = 'Timestamp'
+
+
 class UserHtoOpenApiProperties(BaseModel):
     model_config = ConfigDict(
         extra='allow',
@@ -807,29 +820,6 @@ class JobFilterParameter(BaseModel):
     )
 
 
-class JobHtoOpenApiProperties(BaseModel):
-    model_config = ConfigDict(
-        extra='allow',
-        populate_by_name=True,
-    )
-    name: str | None = Field(None, alias='Name')
-    owner_id: str | None = Field(
-        None, alias='OwnerId', description='The owner of this resource'
-    )
-    created_by: str | None = Field(None, alias='CreatedBy')
-    state: JobStates | None = Field(None, alias='State')
-    tags: List[str] | None = Field(None, alias='Tags')
-    hidden: bool | None = Field(None, alias='Hidden')
-    output_is_deletable: bool | None = Field(None, alias='OutputIsDeletable')
-    created_at: AwareDatetime | None = Field(None, alias='CreatedAt')
-    started_at: AwareDatetime | None = Field(None, alias='StartedAt')
-    completed_at: AwareDatetime | None = Field(None, alias='CompletedAt')
-    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):
     model_config = ConfigDict(
         extra='allow',
@@ -908,64 +898,6 @@ class ProcessingStepDeploymentHto(BaseModel):
     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'
-    )
-    pro_con_version: str | None = Field(
-        None,
-        alias='ProConVersion',
-        description='The version of ProCon used in the code which generated the manifest',
-    )
-    code_hash: str | None = Field(
-        None,
-        alias='CodeHash',
-        description='The hash of the code executing this function. This is intended to inhibit\r\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')
-    hidden: bool | None = Field(None, alias='Hidden')
-    is_deprecated: bool | None = Field(None, alias='IsDeprecated')
-    deprecated_at: AwareDatetime | None = Field(None, alias='DeprecatedAt')
-    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')
-    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):
     model_config = ConfigDict(
         extra='allow',
@@ -1029,6 +961,16 @@ class ProcessingStepUsedTagsHtoOpenApi(BaseModel):
     links: List[Link] | None = None
 
 
+class TagDetailsHto(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+        populate_by_name=True,
+    )
+    key: str | None = Field(None, alias='Key')
+    value: str | None = Field(None, alias='Value')
+    type: TagValueTypes | None = Field(None, alias='Type')
+
+
 class UserHtoOpenApi(BaseModel):
     model_config = ConfigDict(
         extra='allow',
@@ -1079,6 +1021,7 @@ class WorkDataHtoOpenApiProperties(BaseModel):
     created_at: AwareDatetime | None = Field(None, alias='CreatedAt')
     size_in_bytes: int | None = Field(None, alias='SizeInBytes')
     tags: List[str] | None = Field(None, alias='Tags')
+    tag_details: List[TagDetailsHto] | None = Field(None, alias='TagDetails')
     media_type: str | None = Field(None, alias='MediaType')
     kind: WorkDataKind | None = Field(None, alias='Kind')
     is_deletable: bool | None = Field(None, alias='IsDeletable')
@@ -1174,17 +1117,28 @@ class AdminProcessingStepQueryParameters(BaseModel):
     include_remaining_tags: bool | None = Field(None, alias='IncludeRemainingTags')
 
 
-class JobHtoOpenApi(BaseModel):
+class JobHtoOpenApiProperties(BaseModel):
     model_config = ConfigDict(
         extra='allow',
         populate_by_name=True,
     )
-    class_: List[str] | None = Field(None, alias='class')
-    title: str | None = None
-    properties: JobHtoOpenApiProperties | None = None
-    entities: List[Any] | None = None
-    actions: List[Action] | None = None
-    links: List[Link] | None = None
+    name: str | None = Field(None, alias='Name')
+    owner_id: str | None = Field(
+        None, alias='OwnerId', description='The owner of this resource'
+    )
+    created_by: str | None = Field(None, alias='CreatedBy')
+    state: JobStates | None = Field(None, alias='State')
+    tags: List[str] | None = Field(None, alias='Tags')
+    tag_details: List[TagDetailsHto] | None = Field(None, alias='TagDetails')
+    hidden: bool | None = Field(None, alias='Hidden')
+    output_is_deletable: bool | None = Field(None, alias='OutputIsDeletable')
+    created_at: AwareDatetime | None = Field(None, alias='CreatedAt')
+    started_at: AwareDatetime | None = Field(None, alias='StartedAt')
+    completed_at: AwareDatetime | None = Field(None, alias='CompletedAt')
+    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 JobQueryParameters(BaseModel):
@@ -1198,17 +1152,63 @@ class JobQueryParameters(BaseModel):
     include_remaining_tags: bool | None = Field(None, alias='IncludeRemainingTags')
 
 
-class ProcessingStepHtoOpenApi(BaseModel):
+class ProcessingStepHtoOpenApiProperties(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[Any] | None = None
-    actions: List[Action] | None = None
-    links: List[Link] | None = None
+    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'
+    )
+    pro_con_version: str | None = Field(
+        None,
+        alias='ProConVersion',
+        description='The version of ProCon used in the code which generated the manifest',
+    )
+    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')
+    tag_details: List[TagDetailsHto] | None = Field(None, alias='TagDetails')
+    hidden: bool | None = Field(None, alias='Hidden')
+    is_deprecated: bool | None = Field(None, alias='IsDeprecated')
+    deprecated_at: AwareDatetime | None = Field(None, alias='DeprecatedAt')
+    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')
+    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 ProcessingStepQueryParameters(BaseModel):
@@ -1235,3 +1235,29 @@ class WorkDataHtoOpenApi(BaseModel):
     entities: List[Any] | None = None
     actions: List[Action] | None = None
     links: List[Link] | None = None
+
+
+class JobHtoOpenApi(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+        populate_by_name=True,
+    )
+    class_: List[str] | None = Field(None, alias='class')
+    title: str | None = None
+    properties: JobHtoOpenApiProperties | None = None
+    entities: List[Any] | None = None
+    actions: List[Action] | None = None
+    links: List[Link] | None = None
+
+
+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[Any] | None = None
+    actions: List[Action] | None = None
+    links: List[Link] | None = None

pinexq/client/job_management/tool/__init__.py

@@ -1,4 +1,4 @@
-from .job import Job
+from .job import Job, JobQuery
 from .job_group import JobGroup
-from .processing_step import ProcessingStep
-from .workdata import WorkData
+from .processing_step import ProcessingStep, ProcessingStepQuery
+from .workdata import WorkData, WorkDataQuery

pinexq/client/job_management/tool/job.py

@@ -3,14 +3,15 @@ import json as json_
 import queue
 import warnings
 from datetime import datetime, timedelta
-from typing import Any, List, Self
+from typing import Any, Iterator, List, Self
 
 import httpx
 from httpx import URL
-from pydantic import BaseModel, ConfigDict
+from pydantic import AnyUrl, AwareDatetime, BaseModel, ConfigDict
 
 from ...core import ApiException, ClientException, Link, MediaTypes
 from ...core.api_event_manager import ApiEventManagerSingleton
+from ...core.hco.unavailable import UnavailableLink
 from ...core.polling import PollingException, wait_until
 from ..enterjma import enter_jma
 from ..hcos import InputDataSlotHco, OutputDataSlotHco, ProcessingStepLink, WorkDataLink
@@ -27,8 +28,10 @@ from ..model import (
     InputDataSlotParameter,
     JobFilterParameter,
     JobQueryParameters,
+    JobSortProperties,
     JobSortPropertiesSortParameter,
     JobStates,
+    Pagination,
     ProcessingStepFilterParameter,
     ProcessingStepQueryParameters,
     ProcessingView,
@@ -37,6 +40,7 @@ from ..model import (
     SelectWorkDataCollectionForDataSlotParameters,
     SelectWorkDataForDataSlotParameters,
     SetJobTagsParameters,
+    SortTypes,
 )
 from ..tool.processing_step import ProcessingStep
 from ..tool.workdata import WorkData
@@ -53,10 +57,10 @@ class InputDataSlotParameterFlexible(BaseModel):
 
     @classmethod
     def create(cls, *,
-        index: int,
-        work_data_urls: List[WorkDataLink] | None = None,
-        work_data_instances: List[WorkData] | None = None
-    ) -> "InputDataSlotParameterFlexible":
+               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:
@@ -81,6 +85,7 @@ class InputDataSlotParameterFlexible(BaseModel):
             work_data_instances=None
         )
 
+
 class Job:
     """Convenience wrapper for handling JobHcos in the JobManagement-Api.
 
@@ -322,7 +327,8 @@ class Job:
         result = self.job_hco.result
         return json_.loads(result) if result else None
 
-    def wait_for_state_sse(self, state: JobStates, timeout_s: float | None = None, fallback_polling_interval_s: float = 300) -> 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
@@ -391,10 +397,10 @@ class Job:
         try:
             wait_until(
                 condition=lambda: self.get_state() == state,
-                timeout_ms= int(timeout_s * 1000) if timeout_s is not None else None,
+                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= int(polling_interval_s * 1000)
+                polling_interval_ms=int(polling_interval_s * 1000)
             )
         except TimeoutError as timeout:
             raise TimeoutError(
@@ -578,15 +584,15 @@ class Job:
         """
         wait_until(
             condition=lambda: self.sub_jobs_in_state(JobStates.pending) == 0,
-            timeout_ms= int(timeout_s * 1000),
+            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)
+            polling_interval_ms=int(polling_interval_s * 1000)
         )
         wait_until(
             condition=lambda: self.sub_jobs_in_state(JobStates.processing) == 0,
-            timeout_ms= int(timeout_s * 1000),
+            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)
+            polling_interval_ms=int(polling_interval_s * 1000)
         )
 
         error_count = self.sub_jobs_in_state(JobStates.error)
@@ -639,7 +645,7 @@ class Job:
             delete_output_workdata=delete_output_workdata,
             delete_input_workdata=delete_input_workdata,
             delete_subjobs_with_data=delete_subjobs_with_data,
-            recursion_depth = 0)
+            recursion_depth=0)
 
     def _delete_with_associated_internal(
             self,
@@ -664,7 +670,7 @@ class Job:
                         delete_output_workdata=delete_output_workdata,
                         delete_input_workdata=delete_input_workdata,
                         delete_subjobs_with_data=delete_subjobs_with_data,
-                        recursion_depth = recursion_depth + 1)
+                        recursion_depth=recursion_depth + 1)
                     if subjob.self_link.exists():
                         warnings.warn(f"Could not delete subjob: {subjob.self_link.get_url()}")
                 except (ClientException, ApiException) as e:
@@ -887,3 +893,138 @@ class Job:
     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.")
+
+
+class JobQuery:
+    """Convenience wrapper for querying Jobs.
+    """
+
+    _client: httpx.Client
+    _entrypoint: EntryPointHco
+    _jobs_root: JobsRootHco
+    parameters: JobQueryParameters
+
+    def __init__(self, client: httpx.Client, parameters: JobQueryParameters):
+        self._client = client
+        self._entrypoint = enter_jma(client)
+        self._jobs_root = self._entrypoint.job_root_link.navigate()
+        self.parameters = parameters
+
+    @classmethod
+    def from_parameters(cls, client: httpx.Client, parameters: JobQueryParameters) -> Self:
+        """Create a JobQuery from a JobQueryParameters object.
+        """
+        return cls(client, parameters)
+
+    @classmethod
+    def create(
+            cls,
+            client: httpx.Client,
+            *,
+            page_size: int | None = None,
+            page_offset: int | None = None,
+            sort_by_property_name: JobSortProperties | None = None,
+            sort_by_sort_type: SortTypes | None = None,
+            include_remaining_tags: bool | None = None,
+            state: JobStates | None = None,
+            name: str | None = None,
+            show_hidden: bool | None = None,
+            work_data_url: AnyUrl | None = None,
+            created_before: AwareDatetime | None = None,
+            created_after: AwareDatetime | None = None,
+            tags_by_and: list[str] | None = None,
+            tags_by_or: list[str] | None = None,
+            processing_step_url: AnyUrl | None = None,
+            is_sub_job: bool | None = None,
+            parent_job_url: AnyUrl | None = None
+    ) -> Self:
+        """Create a JobQuery from flat parameters.
+        """
+        filter_param = JobFilterParameter(
+            state=state,
+            name=name,
+            show_hidden=show_hidden,
+            work_data_url=work_data_url,
+            created_before=created_before,
+            created_after=created_after,
+            tags_by_and=tags_by_and,
+            tags_by_or=tags_by_or,
+            processing_step_url=processing_step_url,
+            is_sub_job=is_sub_job,
+            parent_job_url=parent_job_url
+        )
+
+        sort_by = None
+        if sort_by_property_name is not None or sort_by_sort_type is not None:
+            sort_by = JobSortPropertiesSortParameter(
+                property_name=sort_by_property_name,
+                sort_type=sort_by_sort_type
+            )
+
+        pagination = None
+        if page_size is not None or page_offset is not None:
+            pagination = Pagination(page_size=page_size, page_offset=page_offset)
+
+        parameters = JobQueryParameters(
+            sort_by=sort_by,
+            filter=filter_param,
+            pagination=pagination,
+            include_remaining_tags=include_remaining_tags
+        )
+        return cls(client, parameters)
+
+    def execute(self) -> JobQueryResultHco:
+        """Executes the query and returns a JobQueryResultHco.
+        """
+        return self._jobs_root.job_query_action.execute(self.parameters)
+
+    def count(self) -> int:
+        """Returns the total number of entities matching the query.
+        """
+        return self.execute().total_entities
+
+    def exists(self) -> bool:
+        """Returns True if there are any entities matching the query.
+        """
+        return self.count() > 0
+
+    def first(self) -> Job | None:
+        """Returns the first entity matching the query, or None if no entities match.
+        """
+        result = self.execute()
+        if result.jobs:
+            return Job.from_hco(result.jobs[0])
+        return None
+
+    def one(self) -> Job:
+        """Returns exactly one entity matching the query.
+        Raises an exception if no entities are found or if multiple entities match.
+        """
+        result = self.execute()
+        if result.total_entities == 0:
+            raise Exception("No entities found matching the query.")
+        if result.total_entities > 1:
+            raise Exception(f"Expected exactly one entity, but found {result.total_entities}.")
+        return Job.from_hco(result.jobs[0])
+
+    def to_list(self) -> list[Job]:
+        """Returns all entities matching the query as a list.
+        """
+        return list(self.iter())
+
+    def to_job_group(self) -> 'JobGroup':
+        """Returns a JobGroup containing all jobs matching the query.
+        """
+        from .job_group import JobGroup
+        return JobGroup.from_query_result(self.execute())
+
+    def iter(self) -> Iterator[Job]:
+        """
+        Returns an Iterator of `Job` so that all jobs can be processed in a loop.
+
+        Returns:
+            An iterator of `Job` objects
+        """
+        for page in self.execute().iter():
+            for job_hco in page.jobs:
+                yield Job.from_hco(job_hco)

pinexq/client/job_management/tool/processing_step.py

@@ -1,8 +1,10 @@
-from typing import Any, Optional, Self
+from typing import Any, Iterator, Optional, Self
 
 import httpx
 from httpx import URL
 
+from pydantic import AnyUrl, AwareDatetime
+
 from ...core import Link, MediaTypes
 from ...core.hco.upload_action_hco import UploadParameters
 from ..enterjma import enter_jma
@@ -23,10 +25,15 @@ from ..model import (
     DeploymentStates,
     DeprecatePsActionParameters,
     FunctionNameMatchTypes,
+    Pagination,
     ProcessingStepFilterParameter,
     ProcessingStepQueryParameters,
+    ProcessingStepSortProperties,
+    ProcessingStepSortPropertiesSortParameter,
     ScalingConfiguration,
-    SetProcessingStepTagsParameters, SetProcessingStepTitleParameters,
+    SetProcessingStepTagsParameters,
+    SetProcessingStepTitleParameters,
+    SortTypes,
 )
 
 
@@ -469,3 +476,137 @@ class ProcessingStep:
     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.")
+
+
+class ProcessingStepQuery:
+    """Convenience wrapper for querying ProcessingSteps.
+    """
+
+    _client: httpx.Client
+    _entrypoint: EntryPointHco
+    _processing_steps_root: ProcessingStepsRootHco
+    parameters: ProcessingStepQueryParameters
+
+    def __init__(self, client: httpx.Client, parameters: ProcessingStepQueryParameters):
+        self._client = client
+        self._entrypoint = enter_jma(client)
+        self._processing_steps_root = self._entrypoint.processing_step_root_link.navigate()
+        self.parameters = parameters
+
+    @classmethod
+    def from_parameters(cls, client: httpx.Client, parameters: ProcessingStepQueryParameters) -> Self:
+        """Create a ProcessingStepQuery from a ProcessingStepQueryParameters object.
+        """
+        return cls(client, parameters)
+
+    @classmethod
+    def create(
+            cls,
+            client: httpx.Client,
+            *,
+            page_size: int | None = None,
+            page_offset: int | None = None,
+            sort_by_property_name: ProcessingStepSortProperties | None = None,
+            sort_by_sort_type: SortTypes | None = None,
+            include_remaining_tags: bool | None = None,
+            function_name: str | None = None,
+            function_name_match_type: FunctionNameMatchTypes | None = None,
+            title_contains: str | None = None,
+            version: str | None = None,
+            description_contains: str | None = None,
+            tags_by_and: list[str] | None = None,
+            tags_by_or: list[str] | None = None,
+            is_public: bool | None = None,
+            show_hidden: bool | None = None,
+            show_deprecated: bool | None = None,
+            deployment_state: DeploymentStates | None = None,
+            show_prerelease: bool | None = None,
+            pro_con_version: str | None = None
+    ) -> Self:
+        """Create a ProcessingStepQuery from flat parameters.
+        """
+        filter_param = ProcessingStepFilterParameter(
+            function_name=function_name,
+            function_name_match_type=function_name_match_type,
+            title_contains=title_contains,
+            version=version,
+            description_contains=description_contains,
+            tags_by_and=tags_by_and,
+            tags_by_or=tags_by_or,
+            is_public=is_public,
+            show_hidden=show_hidden,
+            show_deprecated=show_deprecated,
+            deployment_state=deployment_state,
+            show_prerelease=show_prerelease,
+            pro_con_version=pro_con_version
+        )
+
+        sort_by = None
+        if sort_by_property_name is not None or sort_by_sort_type is not None:
+            sort_by = ProcessingStepSortPropertiesSortParameter(
+                property_name=sort_by_property_name,
+                sort_type=sort_by_sort_type
+            )
+
+        pagination = None
+        if page_size is not None or page_offset is not None:
+            pagination = Pagination(page_size=page_size, page_offset=page_offset)
+
+        parameters = ProcessingStepQueryParameters(
+            sort_by=sort_by,
+            filter=filter_param,
+            pagination=pagination,
+            include_remaining_tags=include_remaining_tags
+        )
+
+        return cls(client, parameters)
+
+    def execute(self) -> ProcessingStepQueryResultHco:
+        """Executes the query and returns a ProcessingStepQueryResultHco.
+        """
+        return self._processing_steps_root.query_action.execute(self.parameters)
+
+    def count(self) -> int:
+        """Returns the total number of entities matching the query.
+        """
+        return self.execute().total_entities
+
+    def exists(self) -> bool:
+        """Returns True if there are any entities matching the query.
+        """
+        return self.count() > 0
+
+    def first(self) -> ProcessingStep | None:
+        """Returns the first entity matching the query, or None if no entities match.
+        """
+        result = self.execute()
+        if result.processing_steps:
+            return ProcessingStep.from_hco(result.processing_steps[0])
+        return None
+
+    def one(self) -> ProcessingStep:
+        """Returns exactly one entity matching the query.
+        Raises an exception if no entities are found or if multiple entities match.
+        """
+        result = self.execute()
+        if result.total_entities == 0:
+            raise Exception("No entities found matching the query.")
+        if result.total_entities > 1:
+            raise Exception(f"Expected exactly one entity, but found {result.total_entities}.")
+        return ProcessingStep.from_hco(result.processing_steps[0])
+
+    def to_list(self) -> list[ProcessingStep]:
+        """Returns all entities matching the query as a list.
+        """
+        return list(self.iter())
+
+    def iter(self) -> Iterator[ProcessingStep]:
+        """
+        Returns an Iterator of `ProcessingStep` so that all processing steps can be processed in a loop.
+
+        Returns:
+            An iterator of `ProcessingStep` objects
+        """
+        for page in self.execute().iter():
+            for ps_hco in page.processing_steps:
+                yield ProcessingStep.from_hco(ps_hco)

pinexq/client/job_management/tool/workdata.py

@@ -1,15 +1,33 @@
 from io import IOBase
-from typing import Any, AsyncIterable, Iterable, Self
+from typing import Any, AsyncIterable, Iterable, Iterator, Self
 
 import httpx
 from httpx import URL
 
+from pydantic import AnyUrl, AwareDatetime
+
 from ...core import Link, MediaTypes
 from ...core.hco.upload_action_hco import UploadParameters
 from ..enterjma import enter_jma
-from ..hcos import EntryPointHco, WorkDataHco, WorkDataLink, WorkDataRootHco
+from ..hcos import (
+    EntryPointHco,
+    WorkDataHco,
+    WorkDataLink,
+    WorkDataQueryResultHco,
+    WorkDataRootHco,
+)
 from ..known_relations import Relations
-from ..model import CopyWorkDataFromUserToOrgActionParameters, SetTagsWorkDataParameters
+from ..model import (
+    CopyWorkDataFromUserToOrgActionParameters,
+    Pagination,
+    SetTagsWorkDataParameters,
+    SortTypes,
+    WorkDataFilterParameter,
+    WorkDataKind,
+    WorkDataQueryParameters,
+    WorkDataSortProperties,
+    WorkDataSortPropertiesSortParameter,
+)
 
 
 class WorkData:
@@ -188,4 +206,133 @@ class WorkData:
 
     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.")
+            raise Exception("No work data hco present. Maybe this class is used after resource deletion.")
+
+
+class WorkDataQuery:
+    """Convenience wrapper for querying WorkData.
+    """
+
+    _client: httpx.Client
+    _entrypoint: EntryPointHco
+    _work_data_root: WorkDataRootHco
+    parameters: WorkDataQueryParameters
+
+    def __init__(self, client: httpx.Client, parameters: WorkDataQueryParameters):
+        self._client = client
+        self._entrypoint = enter_jma(client)
+        self._work_data_root = self._entrypoint.work_data_root_link.navigate()
+        self.parameters = parameters
+
+    @classmethod
+    def from_parameters(cls, client: httpx.Client, parameters: WorkDataQueryParameters) -> Self:
+        """Create a WorkDataQuery from a WorkDataQueryParameters object.
+        """
+        return cls(client, parameters)
+
+    @classmethod
+    def create(
+            cls,
+            client: httpx.Client,
+            *,
+            page_size: int | None = None,
+            page_offset: int | None = None,
+            sort_by_property_name: WorkDataSortProperties | None = None,
+            sort_by_sort_type: SortTypes | None = None,
+            include_remaining_tags: bool | None = None,
+            name_contains: str | None = None,
+            producer_processing_step_url: AnyUrl | None = None,
+            show_hidden: bool | None = None,
+            media_type_contains: str | None = None,
+            tags_by_and: list[str] | None = None,
+            tags_by_or: list[str] | None = None,
+            is_kind: WorkDataKind | None = None,
+            created_before: AwareDatetime | None = None,
+            created_after: AwareDatetime | None = None,
+            is_deletable: bool | None = None,
+            is_used: bool | None = None
+    ) -> Self:
+        """Create a WorkDataQuery from flat parameters.
+        """
+        filter_param = WorkDataFilterParameter(
+            name_contains=name_contains,
+            producer_processing_step_url=producer_processing_step_url,
+            show_hidden=show_hidden,
+            media_type_contains=media_type_contains,
+            tags_by_and=tags_by_and,
+            tags_by_or=tags_by_or,
+            is_kind=is_kind,
+            created_before=created_before,
+            created_after=created_after,
+            is_deletable=is_deletable,
+            is_used=is_used
+        )
+
+        sort_by = None
+        if sort_by_property_name is not None or sort_by_sort_type is not None:
+            sort_by = WorkDataSortPropertiesSortParameter(
+                property_name=sort_by_property_name,
+                sort_type=sort_by_sort_type
+            )
+
+        pagination = None
+        if page_size is not None or page_offset is not None:
+            pagination = Pagination(page_size=page_size, page_offset=page_offset)
+
+        parameters = WorkDataQueryParameters(
+            sort_by=sort_by,
+            filter=filter_param,
+            pagination=pagination,
+            include_remaining_tags=include_remaining_tags
+        )
+        return cls(client, parameters)
+
+    def execute(self) -> WorkDataQueryResultHco:
+        """Executes the query and returns a WorkDataQueryResultHco.
+        """
+        return self._work_data_root.query_action.execute(self.parameters)
+
+    def count(self) -> int:
+        """Returns the total number of entities matching the query.
+        """
+        return self.execute().total_entities
+
+    def exists(self) -> bool:
+        """Returns True if there are any entities matching the query.
+        """
+        return self.count() > 0
+
+    def first(self) -> WorkData | None:
+        """Returns the first entity matching the query, or None if no entities match.
+        """
+        result = self.execute()
+        if result.workdatas:
+            return WorkData.from_hco(result.workdatas[0])
+        return None
+
+    def one(self) -> WorkData:
+        """Returns exactly one entity matching the query.
+        Raises an exception if no entities are found or if multiple entities match.
+        """
+        result = self.execute()
+        if result.total_entities == 0:
+            raise Exception("No entities found matching the query.")
+        if result.total_entities > 1:
+            raise Exception(f"Expected exactly one entity, but found {result.total_entities}.")
+        return WorkData.from_hco(result.workdatas[0])
+
+    def to_list(self) -> list[WorkData]:
+        """Returns all entities matching the query as a list.
+        """
+        return list(self.iter())
+
+    def iter(self) -> Iterator[WorkData]:
+        """
+        Returns an Iterator of `WorkData` so that all work data can be processed in a loop.
+
+        Returns:
+            An iterator of `WorkData` objects
+        """
+        for page in self.execute().iter():
+            for work_data_hco in page.workdatas:
+                yield WorkData.from_hco(work_data_hco)

{pinexq_client-1.0.0.dist-info → pinexq_client-1.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pinexq-client
-Version: 1.0.0
+Version: 1.2.0
 Summary: A hypermedia-based client for the DataCybernetics PinexQ platform.
 Author: Sebastian Höfer, Mathias Reichardt, Pratik Poudel
 Author-email: Sebastian Höfer <hoefer@data-cybernetics.com>, Mathias Reichardt <reichardt@data-cybernetics.com>, Pratik Poudel <poudel@data-cybernetics.com>

{pinexq_client-1.0.0.dist-info → pinexq_client-1.2.0.dist-info}/RECORD

@@ -18,35 +18,35 @@ pinexq/client/core/model/error.py,sha256=ZDbUlwsj7d8XPMolSSLTFwgs3RBLvOvgmlEtoBu
 pinexq/client/core/model/sirenmodels.py,sha256=vGRQlhM2cSa2caxQel91Jr48KWqM-vMYX32iaQCzIds,5547
 pinexq/client/core/polling.py,sha256=nNEDONEkB3Gu5WUMm2u9RFG1OIclnixaiy7l_U2Z4No,1146
 pinexq/client/core/sirenaccess.py,sha256=F7eZI5Pz79el0D30SYNGsiS2qWaAZF_jrCrUy-q2GgY,6992
-pinexq/client/job_management/__init__.py,sha256=9oipbDOkUAGt2qUCraheklny69n3yvLAUxrMcRTF4OM,598
+pinexq/client/job_management/__init__.py,sha256=s2rP7K9AVbmSExyC8PF7rZ6U1tuvaO8-p4xY3okfYuc,644
 pinexq/client/job_management/enterjma.py,sha256=N_jNM2UhQmWL8e-xBrTHbjZzP7WkX98MyFuKsYgD-XQ,3252
 pinexq/client/job_management/hcos/__init__.py,sha256=TZgs5kuBk3lSBxPfn5ehgbdUgzPy2jn1PC3Ea6VQY-k,584
 pinexq/client/job_management/hcos/entrypoint_hco.py,sha256=omFPggY7XGRWI5ogR85I7BHUi5o6OBnLyMggYh76JEg,2204
 pinexq/client/job_management/hcos/info_hco.py,sha256=iJRjPfb1p4EXqSJA0xSRPxwEpAjquwEOuxHcUICQioI,2013
 pinexq/client/job_management/hcos/input_dataslot_hco.py,sha256=CBw-FND7aUOUquXi3u09KK-BidZ3ChrmLy1pE-jmdvI,3590
-pinexq/client/job_management/hcos/job_hco.py,sha256=dw4S_4bHtZafEgU6moiidkqyakCpOqqKnTTmWU2Ubiw,8764
+pinexq/client/job_management/hcos/job_hco.py,sha256=3XRu5gu31Jq68ljRffFq2vF9uYq-Hb9mCFeikUafhLQ,8836
 pinexq/client/job_management/hcos/job_query_result_hco.py,sha256=52fIrEKS7mVzEt8Ugg1_xP7O2NptCy_v-v6F5h8CXDE,3795
 pinexq/client/job_management/hcos/job_used_tags_hco.py,sha256=BGNGOQE33zW8AhYG8tVn1O4nExetBrKCXzCPfe73W1w,1603
 pinexq/client/job_management/hcos/jobsroot_hco.py,sha256=sKapT6tO7-q0P2bwpoPAH8kIugwYOJeB4IF7nQBFdJI,4716
 pinexq/client/job_management/hcos/output_dataslot_hco.py,sha256=nwS5bY5bCZtvFWgDELCUlTxpa6qdDCD1LM2LoDlmNuM,1475
-pinexq/client/job_management/hcos/processing_step_hco.py,sha256=fxzBeHAdud2PxU8xVOYOZXgA-YUN9_g1nBgA_b3tb2Y,12195
+pinexq/client/job_management/hcos/processing_step_hco.py,sha256=0zaRcp23GH0nhtc_nzHukmE5tinIg-ObPL1zgf6_eZM,12267
 pinexq/client/job_management/hcos/processing_step_used_tags_hco.py,sha256=zsed5d04FpZNacZW9l4x-kflWpl1_thGAJfIsWO0co0,1844
 pinexq/client/job_management/hcos/processingstep_query_result_hco.py,sha256=1TMTfxEucryTPzQl4UZcgJb8Ro-9j9lqo2OMlM_hV6Q,4132
 pinexq/client/job_management/hcos/processingsteproot_hco.py,sha256=O9e9Vj4cAc5qiT7RYEXsRLggKIfN8n4eUr-847cZRvk,4041
 pinexq/client/job_management/hcos/user_hco.py,sha256=qihX1lRbedj37shrzYTjdQPgL_giuSRCLhoUqtq1chs,1019
-pinexq/client/job_management/hcos/workdata_hco.py,sha256=_7iKuMr7nKosYPFFgqxdflgwY3NZ-xeZIgpwdfp9yW8,6968
+pinexq/client/job_management/hcos/workdata_hco.py,sha256=fnLOgFpUeqUbC4t9hc39qbM1IEIUyx8CWeBJGNrdzts,7046
 pinexq/client/job_management/hcos/workdata_query_result_hco.py,sha256=wgFm5SmgSnj9KbvxkPFYYBWnLANQRkf9IdoA-Yvfohs,3766
 pinexq/client/job_management/hcos/workdata_used_tags_query_result_hco.py,sha256=uIDB7admcEe81lhWBp0KOuM2Ric7caD7Em6r41Rm9ps,1888
 pinexq/client/job_management/hcos/workdataroot_hco.py,sha256=WRAFihgbyxJBrGKEhAzQwds57G_WndoS0EAW1AZ38tU,4221
 pinexq/client/job_management/known_relations.py,sha256=do-u2wjb6u_HK2-y604f2gs3rk9O19MTIZpvbkfTSpA,905
 pinexq/client/job_management/model/__init__.py,sha256=iuAKRXdW_Mxo0i3HsBfEzhJJZUKkNe3qs4gLW-ge1PU,63
-pinexq/client/job_management/model/open_api_generated.py,sha256=ONCwkochTvF275POWb0KOHyZkq4x5gW4WmOI5DYA5mo,40771
+pinexq/client/job_management/model/open_api_generated.py,sha256=ydfwdMAoO1Bb9Cqmqmm5IhzMrEM6CUcZLVK-rhRdy_8,41544
 pinexq/client/job_management/model/sirenentities.py,sha256=E29Z2MSAYIO1RYvOW_rDpzUHZUMNMioQd_-k_S4KnbQ,3958
-pinexq/client/job_management/tool/__init__.py,sha256=zPobd-hQyANHzC0-TjJG91z9XrewvE54ZJ6VViymW5M,128
-pinexq/client/job_management/tool/job.py,sha256=w81-WVVjrdg4wNaQ1yoCqJLIvvcLAhCYi-gX4at70WY,34688
+pinexq/client/job_management/tool/__init__.py,sha256=4cPlrnA3lhaqFH2OFB6wyMjidgMpr05QczVJU_59kx4,174
+pinexq/client/job_management/tool/job.py,sha256=cSc-YJh96-ljEDWbx-JLjHCoIwzID8mk9lTQxvG3vDM,39624
 pinexq/client/job_management/tool/job_group.py,sha256=ZFUHTk6j3oZOD52D6SOsREdBm5hVn9iUhLykrN_Ghes,11117
-pinexq/client/job_management/tool/processing_step.py,sha256=vlByzSHNY-f_QwP3O__qKCBuI7QhQiY-G0pkhUC7aJ4,15595
-pinexq/client/job_management/tool/workdata.py,sha256=eDzinv70fa76xP0LjugGzicl8GxkQ6Ozq8rz-c4k5IU,6080
-pinexq_client-1.0.0.dist-info/WHEEL,sha256=XV0cjMrO7zXhVAIyyc8aFf1VjZ33Fen4IiJk5zFlC3g,80
-pinexq_client-1.0.0.dist-info/METADATA,sha256=hTEtC7tMU2-Ig-nRLurKhLd38P1eE5rsGax0193zZa4,3459
-pinexq_client-1.0.0.dist-info/RECORD,,
+pinexq/client/job_management/tool/processing_step.py,sha256=9NzbE8btG3mKGiS6cRAqehgVoolvQQZZDi2MRgvW2mA,20920
+pinexq/client/job_management/tool/workdata.py,sha256=_X-v0t6oIBK-0hwvnpFwcdcO4rEkXmyKwobjZtOfGl0,11131
+pinexq_client-1.2.0.dist-info/WHEEL,sha256=5DEXXimM34_d4Gx1AuF9ysMr1_maoEtGKjaILM3s4w4,80
+pinexq_client-1.2.0.dist-info/METADATA,sha256=bijOyvGFCPm4Z-svbDi_g1VDhjyyKr-aqbZ6TuroJt8,3459
+pinexq_client-1.2.0.dist-info/RECORD,,

{pinexq_client-1.0.0.dist-info → pinexq_client-1.2.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: uv 0.9.26
+Generator: uv 0.9.29
 Root-Is-Purelib: true
 Tag: py3-none-any