yellowdog-python-examples 7.10.2__tar.gz → 7.10.3__tar.gz

{yellowdog_python_examples-7.10.2/yellowdog_python_examples.egg-info → yellowdog_python_examples-7.10.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: yellowdog-python-examples
-Version: 7.10.2
+Version: 7.10.3
 Summary: Example Python commands using the YellowDog Python SDK
 Home-page: https://github.com/yellowdog/python-examples
 Author: YellowDog Limited

{yellowdog_python_examples-7.10.2 → yellowdog_python_examples-7.10.3}/README.md

@@ -581,7 +581,7 @@ All properties are optional except for **`taskType`** (or **`taskTypes`**).
 | `maxWorkers`                           | The maximum number of Workers that can be claimed for the associated Task Group. E.g., `10`.                                                                                                                                               | Yes  | Yes | Yes  |      |
 | `minWorkers`                           | The minimum number of Workers that the associated Task Group requires. This many workers must be claimed before the associated Task Group will start working. E.g., `1`.                                                                   | Yes  | Yes | Yes  |      |
 | `name`                                 | The name of the Work Requirement, Task Group or Task. E.g., `"wr_name"`. Note that the `name` property is not inherited.                                                                                                                   | Yes  | Yes | Yes  | Yes  |
-| `namespaces`                           | Only Worker Pools whose workers match one of the namespaces in this list can be claimed by the Task Group. E.g., `["namespace_1", "namespace_2"]. Defaults to `None`.                                                                      | Yes  | Yes | Yes  |      |
+| `namespaces`                           | Only Workers whose Worker Pools match one of the namespaces in this list can be claimed by the Task Group. E.g., `["namespace_1", "namespace_2"]. Defaults to `None`.                                                                      | Yes  | Yes | Yes  |      |
 | `outputs`                              | The files to be uploaded to the YellowDog Object Store by a Worker node on completion of the Task. E.g., `["results_1.txt", "results_2.txt"]`.                                                                                             | Yes  | Yes | Yes  | Yes  |
 | `outputsOther`                         | Files to be uploaded to the YellowDog Object Store from outside the Tasks's Working Directory by a Worker node on completion of a Task. E.g., `outputsOther = [{"directoryName" = "tmp", "filePattern" = "out.txt", "required" = false}]`. | Yes  | Yes | Yes  | Yes  |
 | `outputsRequired`                      | The files that *must* be uploaded to the YellowDog Object Store by a Worker node on completion of the Task. The Task will fail if any outputs are unavailable.                                                                             | Yes  | Yes | Yes  | Yes  |

yellowdog_python_examples-7.10.3/yd_commands/__init__.py

@@ -0,0 +1 @@
+__version__ = "7.10.3"

{yellowdog_python_examples-7.10.2 → yellowdog_python_examples-7.10.3}/yd_commands/list.py

@@ -31,7 +31,6 @@ from yellowdog_client.model import (
     ObjectDetail,
     Task,
     TaskGroup,
-    TaskSearch,
     WorkerPool,
     WorkerPoolStatus,
     WorkerPoolSummary,
@@ -43,6 +42,7 @@ from yd_commands.interactive import select
 from yd_commands.object_utilities import (
     get_filtered_work_requirements,
     get_task_groups_from_wr_summary,
+    get_tasks,
     list_matching_object_paths,
 )
 from yd_commands.printing import (
@@ -185,11 +185,7 @@ def list_task_groups(work_summary: WorkRequirementSummary):
 
 
 def list_tasks(task_group: TaskGroup, work_summary: WorkRequirementSummary):
-    task_search = TaskSearch(
-        workRequirementId=work_summary.id,
-        taskGroupId=task_group.id,
-    )
-    tasks: List[Task] = CLIENT.work_client.find_tasks(task_search)
+    tasks: List[Task] = get_tasks(CLIENT, work_summary.id, task_group.id)
     tasks = sorted_objects(tasks)
     if ARGS_PARSER.details:
         for task in select(CLIENT, tasks):

{yellowdog_python_examples-7.10.2 → yellowdog_python_examples-7.10.3}/yd_commands/object_utilities.py

@@ -21,6 +21,7 @@ from yellowdog_client.model import (
     ProvisionedWorkerPool,
     Task,
     TaskGroup,
+    TaskSearch,
     WorkerPool,
     WorkerPoolSummary,
     WorkRequirementStatus,
@@ -304,3 +305,29 @@ def list_matching_object_paths(
         for object_path in object_paths
         if object_path.name.startswith(prefix)
     ]
+
+
+def get_task_by_id(
+    client: PlatformClient, wr_id: str, task_group_id: str, task_id: str
+) -> Optional[Task]:
+    """
+    Find a task by its ID.
+    """
+    tasks: List[Task] = get_tasks(client, wr_id, task_group_id)
+    for task in tasks:
+        if task.id == task_id:
+            return task
+
+
+@lru_cache()
+def get_tasks(client: PlatformClient, wr_id: str, task_group_id: str) -> List[Task]:
+    """
+    Return all the tasks in a task group, with caching.
+    There is no native way to search for a task by its id.
+    """
+    task_search = TaskSearch(
+        workRequirementId=wr_id,
+        taskGroupId=task_group_id,
+    )
+    tasks: List[Task] = client.work_client.find_tasks(task_search)
+    return tasks

{yellowdog_python_examples-7.10.2 → yellowdog_python_examples-7.10.3}/yd_commands/show.py

@@ -4,11 +4,11 @@
 Command to show the JSON details of YellowDog entities via their IDs.
 """
 
-from typing import List
+from typing import Optional
 
-from yellowdog_client.model import ConfiguredWorkerPool, Task, TaskSearch
-from yellowdog_client.model.exceptions import InvalidRequestException
+from yellowdog_client.model import ConfiguredWorkerPool, Task
 
+from yd_commands.object_utilities import get_task_by_id
 from yd_commands.printing import print_log, print_warning, print_yd_object
 from yd_commands.wrapper import ARGS_PARSER, CLIENT, main_wrapper
 
@@ -106,15 +106,11 @@ def show_details(ydid: str):
             else:
                 print_warning(f"Task Group ID '{ydid}' not found")
                 return
-            task_search = TaskSearch(
-                workRequirementId=work_requirement.id,
-                taskGroupId=task_group.id,
+            task: Optional[Task] = get_task_by_id(
+                CLIENT, work_requirement.id, task_group.id, ydid
             )
-            tasks: List[Task] = CLIENT.work_client.find_tasks(task_search)
-            for task in tasks:
-                if task.id == ydid:
-                    print_yd_object(task)
-                    return
+            if task is not None:
+                print_yd_object(task)
             else:
                 print_warning(f"Task ID '{ydid}' not found")
 

{yellowdog_python_examples-7.10.2 → yellowdog_python_examples-7.10.3}/yd_commands/shutdown.py

@@ -1,18 +1,12 @@
 #!/usr/bin/env python3
 
 """
-A script to shut down Provisioned Worker Pools.
+A script to shut down Worker Pools.
 """
 
 from typing import List
 
-from yellowdog_client.model import (
-    ComputeRequirement,
-    ComputeRequirementStatus,
-    WorkerPool,
-    WorkerPoolStatus,
-    WorkerPoolSummary,
-)
+from yellowdog_client.model import WorkerPool, WorkerPoolStatus, WorkerPoolSummary
 
 from yd_commands.follow_utils import follow_ids
 from yd_commands.interactive import confirmed, select
@@ -32,12 +26,11 @@ def main():
         return
 
     print_log(
-        "Shutting down Provisioned Worker Pools with Compute Requirements in "
+        "Shutting down Worker Pools in "
         f"namespace '{CONFIG_COMMON.namespace}' and "
-        f"tag starting with '{CONFIG_COMMON.name_tag}' "
-        "(or Configured Worker Pools with names starting with "
-        f"'{CONFIG_COMMON.name_tag}')"
+        f"names including '{CONFIG_COMMON.name_tag}'"
     )
+
     worker_pool_summaries: List[WorkerPoolSummary] = (
         CLIENT.worker_pool_client.find_all_worker_pools()
     )
@@ -49,34 +42,10 @@ def main():
             WorkerPoolStatus.TERMINATED,
             WorkerPoolStatus.SHUTDOWN,
         ]:
-            if "ProvisionedWorkerPool" not in worker_pool_summary.type:
-                # Configured Worker Pool: check worker pool name only
-                if (
-                    worker_pool_summary.name is not None
-                    and worker_pool_summary.name.startswith(CONFIG_COMMON.name_tag)
-                ):
-                    selected_worker_pool_summaries.append(worker_pool_summary)
-                continue
-
-            worker_pool: WorkerPool = get_worker_pool_by_id(
-                CLIENT, worker_pool_summary.id
-            )
-            compute_requirement: ComputeRequirement = (
-                CLIENT.compute_client.get_compute_requirement_by_id(
-                    worker_pool.computeRequirementId
-                )
-            )
-            compute_requirement.tag = (
-                "" if compute_requirement.tag is None else compute_requirement.tag
-            )
             if (
-                compute_requirement.tag.startswith(CONFIG_COMMON.name_tag)
-                and compute_requirement.namespace == CONFIG_COMMON.namespace
-                and compute_requirement.status
-                not in [
-                    ComputeRequirementStatus.TERMINATED,
-                    ComputeRequirementStatus.TERMINATING,
-                ]
+                worker_pool_summary.name is not None
+                and worker_pool_summary.namespace == CONFIG_COMMON.namespace
+                and CONFIG_COMMON.name_tag in worker_pool_summary.name
             ):
                 selected_worker_pool_summaries.append(worker_pool_summary)
 

{yellowdog_python_examples-7.10.2 → yellowdog_python_examples-7.10.3}/yd_commands/variables.py

@@ -42,8 +42,13 @@ from yd_commands.utils import (
 )
 
 # Set up default variable substitutions
+try:
+    USERNAME = getuser().replace(" ", "_").lower()
+except:
+    USERNAME = "default-yd-user"
+
 VARIABLE_SUBSTITUTIONS = {
-    "username": getuser().replace(" ", "_").lower(),
+    "username": USERNAME,
     "date": UTCNOW.strftime("%y%m%d"),
     "time": UTCNOW.strftime("%H%M%S%f")[:-4],
     "datetime": UTCNOW.strftime("%y%m%d-%H%M%S"),

{yellowdog_python_examples-7.10.2 → yellowdog_python_examples-7.10.3/yellowdog_python_examples.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: yellowdog-python-examples
-Version: 7.10.2
+Version: 7.10.3
 Summary: Example Python commands using the YellowDog Python SDK
 Home-page: https://github.com/yellowdog/python-examples
 Author: YellowDog Limited

yellowdog_python_examples-7.10.2/yd_commands/__init__.py

@@ -1 +0,0 @@
-__version__ = "7.10.2"