yellowdog-python-examples 7.11.2__tar.gz → 7.11.4__tar.gz

{yellowdog_python_examples-7.11.2/yellowdog_python_examples.egg-info → yellowdog_python_examples-7.11.4}/PKG-INFO

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

yellowdog_python_examples-7.11.4/yd_commands/__init__.py

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

{yellowdog_python_examples-7.11.2 → yellowdog_python_examples-7.11.4}/yd_commands/args.py

@@ -516,6 +516,18 @@ class CLIParser:
                 required=False,
                 help="list compute instances",
             )
+            parser.add_argument(
+                "--nodes",
+                action="store_true",
+                required=False,
+                help="list worker pool nodes",
+            )
+            parser.add_argument(
+                "--workers",
+                action="store_true",
+                required=False,
+                help="list all workers in a worker pool",
+            )
             parser.add_argument(
                 "--public-ips-only",
                 action="store_true",
@@ -1328,6 +1340,16 @@ class CLIParser:
     def instances(self) -> Optional[bool]:
         return self.args.instances
 
+    @property
+    @allow_missing_attribute
+    def nodes(self) -> Optional[bool]:
+        return self.args.nodes
+
+    @property
+    @allow_missing_attribute
+    def workers(self) -> Optional[bool]:
+        return self.args.workers
+
     @property
     @allow_missing_attribute
     def allowances(self) -> Optional[bool]:

{yellowdog_python_examples-7.11.2 → yellowdog_python_examples-7.11.4}/yd_commands/items.py

@@ -16,10 +16,12 @@ from yellowdog_client.model import (
     MachineImageFamilySummary,
     NamespacePolicy,
     NamespaceStorageConfiguration,
+    Node,
     ObjectPath,
     ProvisionedWorkerPool,
     Task,
     TaskGroup,
+    Worker,
     WorkerPoolSummary,
     WorkRequirementSummary,
 )
@@ -44,6 +46,8 @@ Item = TypeVar(
     ProvisionedWorkerPool,
     Task,
     TaskGroup,
+    Worker,
     WorkRequirementSummary,
     WorkerPoolSummary,
+    Node,
 )

{yellowdog_python_examples-7.11.2 → yellowdog_python_examples-7.11.4}/yd_commands/list.py

@@ -30,12 +30,17 @@ from yellowdog_client.model import (
     NamespacePolicy,
     NamespacePolicySearch,
     NamespaceStorageConfiguration,
+    Node,
+    NodeSearch,
+    NodeStatus,
     ObjectDetail,
     Task,
     TaskGroup,
+    Worker,
     WorkerPool,
     WorkerPoolStatus,
     WorkerPoolSummary,
+    WorkerStatus,
     WorkRequirementStatus,
     WorkRequirementSummary,
 )
@@ -64,7 +69,7 @@ from yd_commands.wrapper import ARGS_PARSER, CLIENT, CONFIG_COMMON, main_wrapper
 @main_wrapper
 def main():
     if not check_for_valid_option():
-        raise Exception("Please choose a single, valid listing type")
+        raise Exception("Please choose a (single) listing type")
 
     # Always use interactive mode for selections
     ARGS_PARSER.interactive = True
@@ -73,7 +78,7 @@ def main():
         list_object_paths()
     elif ARGS_PARSER.work_requirements or ARGS_PARSER.task_groups or ARGS_PARSER.tasks:
         list_work_requirements()
-    elif ARGS_PARSER.worker_pools:
+    elif ARGS_PARSER.worker_pools or ARGS_PARSER.nodes or ARGS_PARSER.workers:
         list_worker_pools()
     elif ARGS_PARSER.compute_requirements or ARGS_PARSER.instances:
         list_compute_requirements()
@@ -100,21 +105,23 @@ def check_for_valid_option() -> bool:
     Only one of the listing options must be selected.
     """
     if [
-        ARGS_PARSER.object_paths,
-        ARGS_PARSER.work_requirements,
-        ARGS_PARSER.task_groups,
-        ARGS_PARSER.tasks,
-        ARGS_PARSER.worker_pools,
+        ARGS_PARSER.allowances,
+        ARGS_PARSER.attribute_definitions,
         ARGS_PARSER.compute_requirements,
         ARGS_PARSER.compute_templates,
-        ARGS_PARSER.source_templates,
-        ARGS_PARSER.keyrings,
         ARGS_PARSER.image_families,
-        ARGS_PARSER.namespace_storage_configurations,
         ARGS_PARSER.instances,
-        ARGS_PARSER.allowances,
-        ARGS_PARSER.attribute_definitions,
+        ARGS_PARSER.keyrings,
         ARGS_PARSER.namespace_policies,
+        ARGS_PARSER.namespace_storage_configurations,
+        ARGS_PARSER.nodes,
+        ARGS_PARSER.object_paths,
+        ARGS_PARSER.source_templates,
+        ARGS_PARSER.task_groups,
+        ARGS_PARSER.tasks,
+        ARGS_PARSER.work_requirements,
+        ARGS_PARSER.worker_pools,
+        ARGS_PARSER.workers,
     ].count(True) == 1:
         return True
     else:
@@ -257,6 +264,20 @@ def list_worker_pools():
     if len(worker_pool_summaries) == 0:
         print_log("No Worker Pools to display")
         return
+
+    if ARGS_PARSER.nodes or ARGS_PARSER.workers:
+        print_log(
+            "Please select the Worker Pool(s) for which to list "
+            f"{'Nodes' if ARGS_PARSER.nodes else 'Workers'}"
+        )
+        worker_pool_summaries = select(
+            CLIENT,
+            sorted_objects(worker_pool_summaries),
+            showing_all=showing_all,
+        )
+        list_nodes(worker_pool_summaries)
+        return
+
     if ARGS_PARSER.details:
         for worker_pool_summary in select(
             CLIENT, sorted_objects(worker_pool_summaries), showing_all=showing_all
@@ -330,9 +351,7 @@ def list_instances(compute_requirement: ComputeRequirement):
     """
     List the instances within a Compute Requirement.
     """
-    instance_search: InstanceSearch = InstanceSearch(
-        computeRequirementId=compute_requirement.id
-    )
+    instance_search = InstanceSearch(computeRequirementId=compute_requirement.id)
     search_client: SearchClient = CLIENT.compute_client.get_instances(
         instance_search=instance_search
     )
@@ -352,10 +371,77 @@ def list_instances(compute_requirement: ComputeRequirement):
         return
 
     if ARGS_PARSER.details:
-        for instance in select(CLIENT, search_client.list_all()):
+        for instance in select(CLIENT, instances):
             print_yd_object(instance)
     else:
-        print_numbered_object_list(CLIENT, search_client.list_all())
+        print_numbered_object_list(CLIENT, instances)
+
+
+def list_nodes(worker_pool_summaries: List[WorkerPoolSummary]):
+    """
+    List the Nodes in a list of Worker Pools.
+    """
+    nodes_all: List[Node] = []
+    for worker_pool_summary in worker_pool_summaries:
+        nodes_search = NodeSearch(
+            worker_pool_summary.id,
+            statuses=[NodeStatus.RUNNING] if ARGS_PARSER.active_only else None,
+        )
+        search_client = CLIENT.worker_pool_client.get_nodes(search=nodes_search)
+        nodes: List[Node] = search_client.list_all()
+        for node in nodes:
+            node.worker_pool_name = worker_pool_summary.name
+        nodes_all += nodes
+
+    if len(nodes_all) == 0:
+        print_log("No Nodes to display")
+        return
+
+    if ARGS_PARSER.workers:
+        list_workers(nodes_all)
+        return
+
+    if ARGS_PARSER.details:
+        for node in select(CLIENT, nodes_all):
+            delattr(node, "worker_pool_name")
+            print_yd_object(node)
+    else:
+        print_numbered_object_list(CLIENT, nodes_all)
+
+
+def list_workers(nodes: List[Node]):
+    """
+    Display a list of workers across all nodes in a worker pool.
+    """
+    workers_all: List[Worker] = []
+    for node in nodes:
+        for worker in node.workers:
+            if ARGS_PARSER.active_only:
+                if worker.status not in [
+                    WorkerStatus.SLEEPING,
+                    WorkerStatus.DOING_TASK,
+                    WorkerStatus.FOUND,
+                ]:
+                    continue
+            # Add extra info to the Worker object
+            worker.worker_tag = node.details.workerTag
+            worker.task_types = node.details.supportedTaskTypes
+            worker.worker_pool_name = node.worker_pool_name
+            workers_all.append(worker)
+
+    if len(workers_all) == 0:
+        print_log("No Workers to display")
+        return
+
+    if not ARGS_PARSER.details:
+        print_numbered_object_list(CLIENT, workers_all)
+        return
+
+    for worker in select(CLIENT, workers_all):
+        delattr(worker, "worker_tag")
+        delattr(worker, "task_types")
+        delattr(worker, "worker_pool_name")
+        print_yd_object(worker)
 
 
 def list_compute_templates():

{yellowdog_python_examples-7.11.2 → yellowdog_python_examples-7.11.4}/yd_commands/load_resources.py

@@ -2,7 +2,7 @@
 Load data for resource creation/update/removal requests.
 """
 
-from sys import argv, exit
+from sys import exit
 from typing import Dict, List
 
 from yd_commands.args import ARGS_PARSER

{yellowdog_python_examples-7.11.2 → yellowdog_python_examples-7.11.4}/yd_commands/printing.py

@@ -33,15 +33,14 @@ from yellowdog_client.model import (
     KeyringSummary,
     MachineImageFamilySummary,
     NamespacePolicy,
-    NodeStatus,
-    NodeSummary,
+    Node,
     ObjectDetail,
     ObjectPath,
     ProvisionedWorkerPool,
     ProvisionedWorkerPoolProperties,
     Task,
     TaskGroup,
-    WorkerPool,
+    Worker,
     WorkerPoolSummary,
     WorkRequirement,
     WorkRequirementSummary,
@@ -212,11 +211,13 @@ TYPE_MAP = {
     KeyringSummary: "Keyring",
     MachineImageFamilySummary: "Machine Image Family",
     NamespacePolicy: "Namespace Policy",
+    Node: "Node",
     ObjectPath: "Object Path",
     ProvisionedWorkerPool: "Provisioned Worker Pool",
     Task: "Task",
     TaskGroup: "Task Group",
     WorkRequirementSummary: "Work Requirement",
+    Worker: "Worker",
     WorkerPoolSummary: "Worker Pool",
 }
 
@@ -347,32 +348,16 @@ def worker_pool_table(
         "Worker Pool Name",
         "Type",
         "Status",
-        "Min/Run/Max",
         "ID",
     ]
     table = []
     for index, worker_pool_summary in enumerate(worker_pool_summaries):
-        worker_pool: WorkerPool = client.worker_pool_client.get_worker_pool_by_id(
-            worker_pool_summary.id
-        )
-        try:
-            min_nodes = str(worker_pool.properties.minNodes)
-        except:
-            min_nodes = "_"
-        try:
-            max_nodes = str(worker_pool.properties.maxNodes)
-        except:
-            max_nodes = "_"
-        node_summary: NodeSummary = worker_pool.nodeSummary
-        nodes_running = node_summary.statusCounts[NodeStatus.RUNNING]
-
         table.append(
             [
                 index + 1,
                 worker_pool_summary.name,
                 f"{worker_pool_summary.type.split('.')[-1:][0].replace('WorkerPool', '')}",
                 f"{worker_pool_summary.status}",
-                f"{min_nodes}/{nodes_running}/{max_nodes}",
                 worker_pool_summary.id,
             ]
         )
@@ -535,6 +520,72 @@ def instances_table(
     return headers, table
 
 
+def nodes_table(
+    nodes: List[Node],
+) -> (List[str], List[str]):
+    headers = [
+        "#",
+        "Worker Pool Name",
+        "Provider",
+        "RAM",
+        "vCPUs",
+        "Task Types",
+        "Worker Tag",
+        "# Workers",
+        "Status",
+        "ID",
+    ]
+    table = []
+    for index, node in enumerate(nodes):
+        if node.details is None:
+            continue
+        table.append(
+            [
+                index + 1,
+                node.worker_pool_name,
+                node.details.provider,
+                node.details.ram,
+                node.details.vcpus,
+                ", ".join(node.details.supportedTaskTypes),
+                node.details.workerTag,
+                len(node.workers),
+                node.status,
+                node.id,
+            ]
+        )
+    return headers, table
+
+
+def workers_table(
+    workers: List[Worker],
+) -> (List[str], List[str]):
+    headers = [
+        "#",
+        "Worker Pool Name",
+        "Task Types",
+        "Worker Tag",
+        "Status",
+        "Claims",
+        "Exclusive?",
+        "ID",
+    ]
+    table = []
+    for index, worker in enumerate(workers):
+        table.append(
+            [
+                index + 1,
+                worker.worker_pool_name,
+                ", ".join(worker.task_types),
+                worker.worker_tag,
+                worker.status,
+                worker.claimCount,
+                worker.exclusive,
+                worker.id,
+            ]
+        )
+    return headers, table
+
+
 def allowances_table(
     allowances: List[Allowance],
 ) -> (List[str], List[str]):
@@ -691,6 +742,10 @@ def print_numbered_object_list(
         headers, table = attribute_definitions_table(objects)
     elif isinstance(objects[0], NamespacePolicy):
         headers, table = namespace_policies_table(objects)
+    elif isinstance(objects[0], Node):
+        headers, table = nodes_table(objects)
+    elif isinstance(objects[0], Worker):
+        headers, table = workers_table(objects)
     else:
         table = []
         for index, obj in enumerate(objects):
@@ -731,7 +786,7 @@ def sorted_objects(
     """
     Sort objects by their 'name' property, or 'namespace' in the case of
     Namespace Storage Configurations, or 'instanceType' in the case of
-    Instances.
+    Instances, etc.
     """
     if len(objects) == 0:
         return objects
@@ -745,6 +800,13 @@ def sorted_objects(
     if isinstance(objects[0], Instance):
         return sorted(objects, key=lambda x: x.instanceType, reverse=reverse)
 
+    if isinstance(objects[0], Node):
+        # Note: worker_pool property is added dynamically in yd_list
+        return sorted(objects, key=lambda x: str(x.worker_pool_name), reverse=reverse)
+
+    if isinstance(objects[0], Worker):
+        return sorted(objects, key=lambda x: str(x.worker_pool_name), reverse=reverse)
+
     if isinstance(objects[0], AWSAvailabilityZone):
         return sorted(objects)
 

{yellowdog_python_examples-7.11.2 → yellowdog_python_examples-7.11.4/yellowdog_python_examples.egg-info}/PKG-INFO

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

yellowdog_python_examples-7.11.2/yd_commands/__init__.py

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