yellowdog-python-examples 7.9.3__tar.gz → 7.10.0__tar.gz

{yellowdog_python_examples-7.9.3/yellowdog_python_examples.egg-info → yellowdog_python_examples-7.10.0}/PKG-INFO

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

{yellowdog_python_examples-7.9.3 → yellowdog_python_examples-7.10.0}/README.md

@@ -115,9 +115,10 @@
    * [yd-start](#yd-start)
    * [yd-hold](#yd-hold)
    * [yd-boost](#yd-boost)
+   * [yd-show](#yd-show)
 
 <!-- Created by https://github.com/ekalinin/github-markdown-toc -->
-<!-- Added by: pwt, at: Thu May  9 16:47:20 BST 2024 -->
+<!-- Added by: pwt, at: Wed Jun 12 11:55:06 BST 2024 -->
 
 <!--te-->
 
@@ -150,6 +151,7 @@ The commands provide the following capabilities:
 - **Boosting** Allowances with the **`yd-boost`** command
 - **Creating, Updating and Removing** Source Templates, Compute Templates, Keyrings, Credentials, Namespace Storage Configurations, Image Families, Allowances, and Configured Worker Pools with the **`yd-create`** and **`yd-remove`** commands
 - **Following Event Streams** for Work Requirements, Worker Pools and Compute Requirements with the **`yd-follow`** command
+- **Showing** the details of any YellowDog entity by its YellowDog ID
 
 The operation of the commands is controlled using TOML configuration files and/or environment variables and command line arguments. In addition, Work Requirements and Worker Pools can be defined using JSON files providing extensive configurability.
 
@@ -2651,3 +2653,21 @@ It can optionally be supplied with a list of the names and/or YDIDs of the speci
 ## yd-boost
 
 The `yd-boost` command is used to boost Allowances by the specified number of hours.
+
+## yd-show
+
+The `yd-show` command will show the details (in JSON) of any YellowDog entity by its YellowDog ID. It supports IDs referring to:
+
+- Compute Source Templates
+- Compute Requirement Templates
+- Compute Requirements
+- Sources
+- Worker Pools
+- Nodes
+- Workers
+- Work Requirements
+- Task Groups
+- Tasks
+- Image Families, Image Groups, and Images
+- Keyrings
+- Allowances

{yellowdog_python_examples-7.9.3 → yellowdog_python_examples-7.10.0}/setup.cfg

@@ -31,6 +31,7 @@ console_scripts =
 	yd-list=yd_commands.list:main
 	yd-provision=yd_commands.provision:main
 	yd-reformat-json=yd_commands.reformat_json:main
+	yd-show=yd_commands.show:main
 	yd-shutdown=yd_commands.shutdown:main
 	yd-submit=yd_commands.submit:main
 	yd-terminate=yd_commands.terminate:main

{yellowdog_python_examples-7.9.3 → yellowdog_python_examples-7.10.0}/tests/test_create_remove.py

@@ -1,6 +1,6 @@
 from cli_test_helpers import shell
 
-RESOURCE_DIR = "resource-examples"
+RESOURCE_DIR = "tests/resource-examples"
 
 
 class TestCreateRemove:
@@ -53,3 +53,17 @@ class TestCreateRemove:
         assert result.exit_code == 0
         result = shell(f"yd-remove -My {resources}")
         assert result.exit_code == 0
+
+    def test_string_attribute(self):
+        resources = f"{RESOURCE_DIR}/stringattribute.json"
+        result = shell(f"yd-create {resources}")
+        assert result.exit_code == 0
+        result = shell(f"yd-remove -y {resources}")
+        assert result.exit_code == 0
+
+    def test_numeric_attribute(self):
+        resources = f"{RESOURCE_DIR}/numericattribute.json"
+        result = shell(f"yd-create {resources}")
+        assert result.exit_code == 0
+        result = shell(f"yd-remove -y {resources}")
+        assert result.exit_code == 0

yellowdog_python_examples-7.10.0/yd_commands/__init__.py

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

{yellowdog_python_examples-7.9.3 → yellowdog_python_examples-7.10.0}/yd_commands/args.py

@@ -802,14 +802,15 @@ class CLIParser:
                 help="remove resources using their YellowDog IDs (YDIDs)",
             )
 
-        if "follow" in sys.argv[0]:
+        if any(module in sys.argv[0] for module in ["follow", "show"]):
+            verb = "follow" if "follow" in sys.argv[0] else "show"
             parser.add_argument(
                 "yellowdog_ids",
                 nargs="+",
                 default=[],
                 metavar="<yellowdog-id>",
                 type=str,
-                help="the YellowDog ID(s) of the item(s) to follow",
+                help=f"the YellowDog ID(s) of the item(s) to {verb}",
             )
 
         if any(

{yellowdog_python_examples-7.9.3 → yellowdog_python_examples-7.10.0}/yd_commands/object_utilities.py

@@ -298,11 +298,9 @@ def list_matching_object_paths(
     if object_paths is None:
         return []
 
-    # Check that the prefix actually matches!
-    object_paths = [
+    # Check the prefix actually matches!
+    return [
         object_path
         for object_path in object_paths
         if object_path.name.startswith(prefix)
     ]
-
-    return object_paths

yellowdog_python_examples-7.10.0/yd_commands/show.py

@@ -0,0 +1,153 @@
+#!/usr/bin/env python3
+
+"""
+Command to show the JSON details of YellowDog entities via their IDs.
+"""
+
+from typing import List
+
+from yellowdog_client.model import Task, TaskSearch
+from yellowdog_client.model.exceptions import InvalidRequestException
+
+from yd_commands.printing import print_log, print_warning, print_yd_object
+from yd_commands.wrapper import ARGS_PARSER, CLIENT, main_wrapper
+
+
+@main_wrapper
+def main():
+
+    ydids_set = set(ARGS_PARSER.yellowdog_ids)
+    if len(ydids_set) < len(ARGS_PARSER.yellowdog_ids):
+        print_warning("Dropping duplicate YDIDs")
+
+    for ydid in ydids_set:
+        show_details(ydid)
+
+
+def show_details(ydid: str):
+    """
+    Show the details for a given YDID
+    """
+    try:
+        if ":cst:" in ydid:
+            print_log(f"Showing details of Compute Source Template ID '{ydid}'")
+            print_yd_object(CLIENT.compute_client.get_compute_source_template(ydid))
+
+        elif ":crt:" in ydid:
+            print_log(f"Showing details of Compute Requirement Template ID '{ydid}'")
+            print_yd_object(
+                CLIENT.compute_client.get_compute_requirement_template(ydid)
+            )
+
+        elif ":compreq:" in ydid:
+            print_log(f"Showing details of Compute Requirement ID '{ydid}'")
+            print_yd_object(CLIENT.compute_client.get_compute_requirement_by_id(ydid))
+
+        elif ":compsrc:" in ydid:
+            print_log(f"Showing details of Compute Source ID '{ydid}'")
+            compute_requirement = CLIENT.compute_client.get_compute_requirement_by_id(
+                ydid.rsplit(":", 1)[0].replace("compsrc", "compreq")
+            )
+            for source in compute_requirement.provisionStrategy.sources:
+                if source.id == ydid:
+                    print_yd_object(source)
+                    break
+            else:
+                print_warning(f"Compute Source ID '{ydid}' not found")
+
+        elif ":wrkrpool:" in ydid:
+            print_log(f"Showing details of Worker Pool ID '{ydid}'")
+            print_yd_object(CLIENT.worker_pool_client.get_worker_pool_by_id(ydid))
+
+        elif ":node:" in ydid:
+            print_log(f"Showing details of Node ID '{ydid}'")
+            print_yd_object(CLIENT.worker_pool_client.get_node_by_id(ydid))
+
+        elif ":wrkr:" in ydid:
+            print_log(f"Showing details of Worker ID '{ydid}'")
+            node = CLIENT.worker_pool_client.get_node_by_id(
+                ydid.rsplit(":", 1)[0].replace("wrkr", "node")
+            )
+            for worker in node.workers:
+                if worker.id == ydid:
+                    print_yd_object(worker)
+                    break
+            else:
+                print_warning(f"Worker ID '{ydid}' not found")
+
+        elif ":workreq:" in ydid:
+            print_log(f"Showing details of Work Requirement ID '{ydid}'")
+            print_yd_object(CLIENT.work_client.get_work_requirement_by_id(ydid))
+
+        elif ":taskgrp:" in ydid:
+            print_log(f"Showing details of Task Group ID '{ydid}'")
+            work_requirement = CLIENT.work_client.get_work_requirement_by_id(
+                ydid.rsplit(":", 1)[0].replace("taskgrp", "workreq")
+            )
+            for task_group in work_requirement.taskGroups:
+                if task_group.id == ydid:
+                    print_yd_object(task_group)
+                    break
+            else:
+                print_warning(f"Task Group ID '{ydid}' not found")
+
+        elif ":task:" in ydid:
+            print_log(f"Showing details of Task ID '{ydid}'")
+            work_requirement = CLIENT.work_client.get_work_requirement_by_id(
+                ydid.rsplit(":", 2)[0].replace("task", "workreq")
+            )
+            for task_group in work_requirement.taskGroups:
+                if task_group.id == ydid.rsplit(":", 1)[0].replace("task", "taskgrp"):
+                    break
+            else:
+                print_warning(f"Task Group ID '{ydid}' not found")
+                return
+            task_search = TaskSearch(
+                workRequirementId=work_requirement.id,
+                taskGroupId=task_group.id,
+            )
+            tasks: List[Task] = CLIENT.work_client.find_tasks(task_search)
+            for task in tasks:
+                if task.id == ydid:
+                    print_yd_object(task)
+            else:
+                print_warning(f"Task ID '{ydid}' not found")
+
+        elif ":imgfam:" in ydid:
+            print_log(f"Showing details of Image Family ID '{ydid}'")
+            print_yd_object(CLIENT.images_client.get_image_family_by_id(ydid))
+
+        elif ":imggrp:" in ydid:
+            print_log(f"Showing details of Image Group ID '{ydid}'")
+            print_yd_object(CLIENT.images_client.get_image_group_by_id(ydid))
+
+        elif ":image:" in ydid:
+            print_log(f"Showing details of Image ID '{ydid}'")
+            print_yd_object(CLIENT.images_client.get_image(ydid))
+
+        elif ":keyring:" in ydid:
+            print_log(f"Showing details of Keyring ID '{ydid}'")
+            keyrings = CLIENT.keyring_client.find_all_keyrings()
+            for keyring in keyrings:
+                if keyring.id == ydid:
+                    print_yd_object(keyring)
+                    break
+            else:
+                print_warning(f"Keyring ID '{ydid}' not found")
+
+        elif ":allow:" in ydid:
+            print_log(f"Showing details of Allowance ID '{ydid}'")
+            print_yd_object(CLIENT.allowances_client.get_allowance_by_id(ydid))
+
+        else:
+            print_warning(f"Unknown (or unsupported) YellowDog ID type for '{ydid}'")
+
+    except InvalidRequestException as e:
+        print_warning(f"Unable to show details for '{ydid}': {e}")
+    except Exception as e:
+        print_warning(f"Unable to show details for '{ydid}': {e}")
+
+
+# Entry point
+if __name__ == "__main__":
+    main()

{yellowdog_python_examples-7.9.3 → yellowdog_python_examples-7.10.0/yellowdog_python_examples.egg-info}/PKG-INFO

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

{yellowdog_python_examples-7.9.3 → yellowdog_python_examples-7.10.0}/yellowdog_python_examples.egg-info/SOURCES.txt

@@ -52,6 +52,7 @@ yd_commands/provision_utils.py
 yd_commands/remove.py
 yd_commands/resize.py
 yd_commands/settings.py
+yd_commands/show.py
 yd_commands/shutdown.py
 yd_commands/start.py
 yd_commands/start_hold_common.py

yellowdog_python_examples-7.9.3/yd_commands/__init__.py

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