yellowdog-sdk 9.0.0__py3-none-any.whl → 9.1.0__py3-none-any.whl

yellowdog_client/_version.py

@@ -1,2 +1,2 @@
 
-__version__ = '9.0.0' # YEL-13232
+__version__ = '9.1.0' # YEL-13162

yellowdog_client/scheduler/work_client.py

@@ -6,7 +6,8 @@ from typing import List
 from .work_requirement_helper import WorkRequirementHelper
 from yellowdog_client.common import Closeable, SearchClient
 from yellowdog_client.common.server_sent_events import SubscriptionEventListener
-from yellowdog_client.model import Slice, SliceReference, Task, TaskGroup, TaskSearch, WorkRequirement, WorkRequirementSearch, WorkRequirementSummary
+from yellowdog_client.model import Slice, SliceReference, Task, TaskGroup, TaskSearch, WorkRequirement, \
+    WorkRequirementSearch, WorkRequirementSummary
 
 
 class WorkClient(ABC, Closeable):
@@ -113,29 +114,32 @@ class WorkClient(ABC, Closeable):
         pass
 
     @abstractmethod
-    def cancel_work_requirement(self, work_requirement: WorkRequirement) -> WorkRequirement:
+    def cancel_work_requirement(self, work_requirement: WorkRequirement, abort: bool = False) -> WorkRequirement:
         """
         Instructs the Scheduler to cancel the supplied work requirement, no further tasks will be executed and all workers shall be released.
 
         :param work_requirement: the work requirement to cancel
+        :param abort: if tasks should be aborted if they have been allocated to a worker
         :return: the latest state of the work requirement after the cancel instruction was submitted
         """
 
         pass
 
     @abstractmethod
-    def cancel_work_requirement_by_id(self, work_requirement_id: str) -> WorkRequirement:
+    def cancel_work_requirement_by_id(self, work_requirement_id: str, abort: bool = False) -> WorkRequirement:
         """
         Instructs the Scheduler to cancel the supplied work requirement, no further tasks will be executed and all workers shall be released.
 
         :param work_requirement_id: the ID of the work requirement to cancel
+        :param abort: if tasks should be aborted if they have been allocated to a worker
         :return: the latest state of the work requirement after the cancel instruction was submitted
         """
 
         pass
 
     @abstractmethod
-    def add_work_requirement_listener(self, work_requirement: WorkRequirement, listener: SubscriptionEventListener[WorkRequirement]) -> None:
+    def add_work_requirement_listener(self, work_requirement: WorkRequirement,
+                                      listener: SubscriptionEventListener[WorkRequirement]) -> None:
         """
         Adds an event listener to receive notifications of changes for the specified work requirement.
         The client manages subscriptions to YellowDog Scheduler such that the first listener created for a requirement will cause a Server-Sent Events subscription to be initiated; additional listeners for the same requirement share that subscription.
@@ -147,7 +151,8 @@ class WorkClient(ABC, Closeable):
         pass
 
     @abstractmethod
-    def add_work_requirement_listener_by_id(self, work_requirement_id: str, listener: SubscriptionEventListener[WorkRequirement]) -> None:
+    def add_work_requirement_listener_by_id(self, work_requirement_id: str,
+                                            listener: SubscriptionEventListener[WorkRequirement]) -> None:
         """
         Adds an event listener to receive notifications of changes for the specified work requirement.
         The client manages subscriptions to YellowDog Scheduler such that the first listener created for a requirement will cause a Server-Sent Events subscription to be initiated; additional listeners for the same requirement share that subscription.
@@ -238,7 +243,8 @@ class WorkClient(ABC, Closeable):
         pass
 
     @abstractmethod
-    def add_tasks_to_task_group_by_name(self, namespace: str, work_requirement_name: str, task_group_name: str, tasks: List[Task]) -> List[Task]:
+    def add_tasks_to_task_group_by_name(self, namespace: str, work_requirement_name: str, task_group_name: str,
+                                        tasks: List[Task]) -> List[Task]:
         """
         Submits NEW tasks to the YellowDog Scheduler service to be added to the specified task group.
 

yellowdog_client/scheduler/work_client_impl.py

@@ -58,19 +58,19 @@ class WorkClientImpl(WorkClient):
         return self.hold_work_requirement_by_id(work_requirement.id)
 
     def hold_work_requirement_by_id(self, work_requirement_id: str) -> WorkRequirement:
-        return self.__service_proxy.transition_work_requirement(work_requirement_id, WorkRequirementStatus.HELD)
+        return self.__service_proxy.transition_work_requirement(work_requirement_id, WorkRequirementStatus.HELD, False)
 
     def start_work_requirement(self, work_requirement: WorkRequirement) -> WorkRequirement:
         return self.start_work_requirement_by_id(work_requirement.id)
 
     def start_work_requirement_by_id(self, work_requirement_id: str) -> WorkRequirement:
-        return self.__service_proxy.transition_work_requirement(work_requirement_id, WorkRequirementStatus.RUNNING)
+        return self.__service_proxy.transition_work_requirement(work_requirement_id, WorkRequirementStatus.RUNNING, False)
 
-    def cancel_work_requirement(self, work_requirement: WorkRequirement) -> WorkRequirement:
-        return self.cancel_work_requirement_by_id(work_requirement.id)
+    def cancel_work_requirement(self, work_requirement: WorkRequirement, abort: bool = False) -> WorkRequirement:
+        return self.cancel_work_requirement_by_id(work_requirement.id, abort)
 
-    def cancel_work_requirement_by_id(self, work_requirement_id: str) -> WorkRequirement:
-        return self.__service_proxy.transition_work_requirement(work_requirement_id, WorkRequirementStatus.CANCELLING)
+    def cancel_work_requirement_by_id(self, work_requirement_id: str, abort: bool = False) -> WorkRequirement:
+        return self.__service_proxy.transition_work_requirement(work_requirement_id, WorkRequirementStatus.CANCELLING, abort)
 
     def find_all_work_requirements(self) -> List[WorkRequirementSummary]:
         search = WorkRequirementSearch()

yellowdog_client/scheduler/work_service_proxy.py

@@ -23,9 +23,13 @@ class WorkServiceProxy:
     def get_work_requirement_by_name(self, namespace: str, work_requirement_name: str) -> WorkRequirement:
         return self._proxy.get(WorkRequirement, "namespaces/%s/requirements/%s" % (namespace, work_requirement_name))
 
-    def transition_work_requirement(self, requirement_id: str,
-                                    next_status: WorkRequirementStatus) -> WorkRequirement:
-        url = "requirements/%s/transition/%s" % (requirement_id, str(next_status))
+    def transition_work_requirement(
+            self,
+            requirement_id: str,
+            next_status: WorkRequirementStatus,
+            abort_if_cancelling: bool
+    ) -> WorkRequirement:
+        url = "requirements/%s/transition/%s?abort=%s" % (requirement_id, str(next_status), abort_if_cancelling)
         return self._proxy.put(WorkRequirement, url=url)
 
     def find_work_requirements(self, search: WorkRequirementSearch, slice_reference: SliceReference) -> Slice[WorkRequirementSummary]:

{yellowdog_sdk-9.0.0.dist-info → yellowdog_sdk-9.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yellowdog-sdk
-Version: 9.0.0
+Version: 9.1.0
 Summary: SDK for the YellowDog Platform
 Author-email: YellowDog Limited <support@yellowdog.co>
 Project-URL: Homepage, https://yellowdog.co

{yellowdog_sdk-9.0.0.dist-info → yellowdog_sdk-9.1.0.dist-info}/RECORD

@@ -1,6 +1,6 @@
 __init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 yellowdog_client/__init__.py,sha256=xHGTw5UbjkeEl_hC8_gJCacfji6462qJWD1nvJdFssE,13162
-yellowdog_client/_version.py,sha256=Tc6oNDQwE6Y33AlkRryK323IehSzbGk8uYLYAjFNngo,35
+yellowdog_client/_version.py,sha256=ZtjrQEtRl5TaX372gylcG8I4Aa_86zEsky-HhcgfcxQ,35
 yellowdog_client/client_collection.py,sha256=VSEzjf6iR1qCQ0YGLyDq_Kgvw8r832QDwTp6-MLB4Vs,388
 yellowdog_client/platform_client.py,sha256=h_9sd35e0GMdVGjSjG0KGcG3w1qLGY1Vf1U1gSor-HE,7052
 yellowdog_client/account/__init__.py,sha256=wx5GbsoODMdXbOmRoNZu5VYgDJX-RqsFb9ph14HXoV4,235
@@ -445,10 +445,10 @@ yellowdog_client/object_store/utils/memory_mapped_file_writter.py,sha256=8l9E_m8
 yellowdog_client/scheduler/__init__.py,sha256=ZORtc_LUBoTcplpoDhCHZNannI3qjeohghNcoBYU3ts,927
 yellowdog_client/scheduler/predicated_work_subscription_event_listener.py,sha256=mLfaVRmIMtQbj9u6d8O_B-VaZxOy5l1kuGCfTsS_xPU,2056
 yellowdog_client/scheduler/predicated_worker_pool_subscription_event_listener.py,sha256=z7tCniTF8WL6HSV7QcMOWFvC9EGSRopBGLODFOQinTA,2080
-yellowdog_client/scheduler/work_client.py,sha256=Z0bz-SvjMiTDQ-fhGW3dSHTQrgipORJqPpDRDYiw98g,12792
-yellowdog_client/scheduler/work_client_impl.py,sha256=Pi8r7A8nvi6NUZUHlXXyV1IMxi3H4SaBNjvV1oHM3FU,7273
+yellowdog_client/scheduler/work_client.py,sha256=vaF2lWLtJkd5D16GGYUfde3nv7A5w4BcwxtacjrvNtg,13140
+yellowdog_client/scheduler/work_client_impl.py,sha256=33O8T25bV-zHx3R3gSQ047NGuSmpWESn7sCaZmqgLFo,7343
 yellowdog_client/scheduler/work_requirement_helper.py,sha256=vQMoI9emTMKLLmZSil3IGNUtxUl50MFuITJTv5Okvlo,4167
-yellowdog_client/scheduler/work_service_proxy.py,sha256=ds0qiYHiOq9hdInjt1ynWE4GtifZlJEeh5HVDbKtTGc,2920
+yellowdog_client/scheduler/work_service_proxy.py,sha256=bSg0892B82uAN3zXSUGoSF0BjVzhTuzuZNEMS-wZRIw,2995
 yellowdog_client/scheduler/worker_pool_client.py,sha256=FIFoXu0COUW_GBATqfWoZpxrOHLjLbVlWMEw5JaR5vg,15430
 yellowdog_client/scheduler/worker_pool_client_impl.py,sha256=KdDMGFfBqBAIh1HFik__0GNoIYI1dBRNwF-e9H2h9c0,8913
 yellowdog_client/scheduler/worker_pool_helper.py,sha256=TZWm4x5S4atmjvZjgt7xhx8hcsnGI087WJrqllJDK-U,1340
@@ -457,8 +457,8 @@ yellowdog_client/usage/__init__.py,sha256=XQwRJqTdxKZa1QUTsxBEL0TqQJeQHGyPklFeqc
 yellowdog_client/usage/allowances_client.py,sha256=H6n63jXjT4OwuWJgFUXSjSmvGTZz9uspy3kj3upinaA,1337
 yellowdog_client/usage/allowances_client_impl.py,sha256=nQPnSzJKhL3WvyCn5fmiDkwE84xZryH9YvV5Z1GjU4M,2061
 yellowdog_client/usage/allowances_service_proxy.py,sha256=uO6LWnpjIzUcZTGdOxPXn7SyYX7NMRqO5KUiHUGr490,1320
-yellowdog_sdk-9.0.0.dist-info/licenses/LICENSE,sha256=QwcOLU5TJoTeUhuIXzhdCEEDDvorGiC6-3YTOl4TecE,11356
-yellowdog_sdk-9.0.0.dist-info/METADATA,sha256=7mjzdxZu7PzlMxa6AYS5nhVjT_rpGhU0to7W-Q6mabs,3238
-yellowdog_sdk-9.0.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-yellowdog_sdk-9.0.0.dist-info/top_level.txt,sha256=6PH16DcoqpYHhQ5A0UJOjf0tg-1rTrNC9C2CLqCMuFo,26
-yellowdog_sdk-9.0.0.dist-info/RECORD,,
+yellowdog_sdk-9.1.0.dist-info/licenses/LICENSE,sha256=QwcOLU5TJoTeUhuIXzhdCEEDDvorGiC6-3YTOl4TecE,11356
+yellowdog_sdk-9.1.0.dist-info/METADATA,sha256=sOSorct_Lyjcm-h5sOYoCYofMMLwfhXbV-ibFQDkpxg,3238
+yellowdog_sdk-9.1.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+yellowdog_sdk-9.1.0.dist-info/top_level.txt,sha256=6PH16DcoqpYHhQ5A0UJOjf0tg-1rTrNC9C2CLqCMuFo,26
+yellowdog_sdk-9.1.0.dist-info/RECORD,,