yellowdog-python-examples 7.18.3__tar.gz → 7.18.4__tar.gz

{yellowdog_python_examples-7.18.3/yellowdog_python_examples.egg-info → yellowdog_python_examples-7.18.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yellowdog-python-examples
-Version: 7.18.3
+Version: 7.18.4
 Summary: Python CLI commands using the YellowDog Python SDK
 Author-email: YellowDog Limited <support@yellowdog.co>
 Project-URL: Homepage, https://github.com/yellowdog/python-examples

yellowdog_python_examples-7.18.4/yellowdog_cli/__init__.py

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

{yellowdog_python_examples-7.18.3 → yellowdog_python_examples-7.18.4}/yellowdog_cli/list.py

@@ -59,6 +59,7 @@ from yellowdog_cli.utils.entity_utils import (
     get_user_groups,
     list_matching_object_paths,
     substitute_ids_for_names_in_crt,
+    substitute_image_family_id_for_name_in_cst,
 )
 from yellowdog_cli.utils.interactive import confirmed, select
 from yellowdog_cli.utils.misc_utils import unpack_namespace_in_prefix
@@ -108,7 +109,8 @@ def main():
     if ARGS_PARSER.output_file and ARGS_PARSER.details:
         if exists(ARGS_PARSER.output_file):
             if not confirmed(
-                f"Overwrite file '{ARGS_PARSER.output_file}' with resource details?"
+                f"Overwrite file '{ARGS_PARSER.output_file}' with new "
+                "resource details?"
             ):
                 return
 
@@ -129,7 +131,7 @@ def main():
     elif ARGS_PARSER.image_families:
         list_image_families()
     elif ARGS_PARSER.namespace_storage_configurations:
-        list_namespaces()
+        list_namespace_storage_configurations()
     elif ARGS_PARSER.allowances:
         list_allowances()
     elif ARGS_PARSER.attribute_definitions:
@@ -627,7 +629,10 @@ def list_compute_source_templates():
     cs_templates = select(CLIENT, sorted_objects(cs_templates))
     cs_template_details = [
         (
-            CLIENT.compute_client.get_compute_source_template(cs_template.id),
+            substitute_image_family_id_for_name_in_cst(
+                CLIENT,
+                CLIENT.compute_client.get_compute_source_template(cs_template.id),
+            ),
             RN_SOURCE_TEMPLATE,
         )
         for cs_template in cs_templates
@@ -716,7 +721,7 @@ def list_image_families():
     )
 
 
-def list_namespaces():
+def list_namespace_storage_configurations():
     """
     List Storage Namespaces. For now, prints a table directly rather than
     calling the printing module, due to it being a bit fiddly.
@@ -972,6 +977,11 @@ def list_roles():
     print_log("Obtaining permissions for each role ...")
     roles: List[Role] = [CLIENT.account_client.get_role(x.id) for x in role_summaries]
 
+    # Sort permissions alphabetically (contorting the type)
+    for role in roles:
+        role.permissions = list(role.permissions)
+        role.permissions.sort(key=lambda permission: permission.name)
+
     if not ARGS_PARSER.details:
         print_numbered_object_list(CLIENT, roles, object_type_name="Role")
         return

{yellowdog_python_examples-7.18.3 → yellowdog_python_examples-7.18.4}/yellowdog_cli/show.py

@@ -7,7 +7,10 @@ Command to show the JSON details of YellowDog entities via their IDs.
 from yellowdog_client.model import ConfiguredWorkerPool
 
 from yellowdog_cli.list import get_keyring
-from yellowdog_cli.utils.entity_utils import substitute_ids_for_names_in_crt
+from yellowdog_cli.utils.entity_utils import (
+    substitute_ids_for_names_in_crt,
+    substitute_image_family_id_for_name_in_cst,
+)
 from yellowdog_cli.utils.printing import print_error, print_log, print_yd_object
 from yellowdog_cli.utils.settings import (
     RESOURCE_PROPERTY_NAME,
@@ -60,8 +63,12 @@ def show_details(ydid: str, initial_indent: int = 0, with_final_comma: bool = Fa
         ydid_type = get_ydid_type(ydid)
         if ydid_type == YDIDType.COMPUTE_SOURCE_TEMPLATE:
             print_log(f"Showing details of Compute Source Template ID '{ydid}'")
+            if ARGS_PARSER.substitute_ids:
+                print_log("Substituting Image Family ID with name")
             print_yd_object(
-                CLIENT.compute_client.get_compute_source_template(ydid),
+                substitute_image_family_id_for_name_in_cst(
+                    CLIENT, CLIENT.compute_client.get_compute_source_template(ydid)
+                ),
                 initial_indent=initial_indent,
                 with_final_comma=with_final_comma,
                 add_fields=({RESOURCE_PROPERTY_NAME: RN_SOURCE_TEMPLATE}),

{yellowdog_python_examples-7.18.3 → yellowdog_python_examples-7.18.4}/yellowdog_cli/utils/args.py

@@ -7,7 +7,10 @@ import sys
 from typing import List, Optional
 
 from yellowdog_cli.__init__ import __version__
-from yellowdog_cli.utils.settings import MAX_PARALLEL_TASK_BATCH_UPLOAD_THREADS
+from yellowdog_cli.utils.settings import (
+    DEFAULT_URL,
+    MAX_PARALLEL_TASK_BATCH_UPLOAD_THREADS,
+)
 from yellowdog_cli.version import DOCS_URL
 
 
@@ -66,24 +69,23 @@ class CLIParser:
             "-k",
             type=str,
             required=False,
-            help="the YellowDog Application key",
-            metavar="<app-key>",
+            help="the application key ID",
+            metavar="<app-key-id>",
         )
         parser.add_argument(
             "--secret",
             "-s",
             required=False,
             type=str,
-            help="the YellowDog Application secret",
-            metavar="<app-secret>",
+            help="the application key secret",
+            metavar="<app-key-secret>",
         )
-
         parser.add_argument(
             "--url",
             "-u",
             type=str,
             required=False,
-            help="the URL of the YellowDog Platform API",
+            help=f"the YellowDog Platform API URL (defaults to '{DEFAULT_URL}')",
             metavar="<url>",
         )
         parser.add_argument(
@@ -401,6 +403,7 @@ class CLIParser:
                 "boost",
                 "hold",
                 "start",
+                "list",
             ]
         ):
             parser.add_argument(
@@ -408,7 +411,10 @@ class CLIParser:
                 "-y",
                 action="store_true",
                 required=False,
-                help="perform modifying actions without requiring user confirmation",
+                help=(
+                    "perform modifying/destructive actions without "
+                    "requiring user confirmation"
+                ),
             )
 
         if any(module in sys.argv[0] for module in ["delete", "download"]):
@@ -671,7 +677,7 @@ class CLIParser:
                 "--auto-select-all",
                 action="store_true",
                 required=False,
-                help="use with '--details' to select all objects automatically",
+                help="automatically select all listed objects (implies '--details')",
             )
 
         if any(module in sys.argv[0] for module in ["upload"]):
@@ -1171,8 +1177,10 @@ class CLIParser:
                 action="store_true",
                 required=False,
                 help=(
-                    "use with '--details' to substitute compute source template IDs and "
-                    "image family IDs for names in detailed compute requirement templates"
+                    "substitute compute source template IDs and image family IDs "
+                    "for names in detailed compute requirement templates, "
+                    "and image family IDs in compute source templates "
+                    "(implies '--details')"
                 ),
             )
             parser.add_argument(
@@ -1180,8 +1188,10 @@ class CLIParser:
                 action="store_true",
                 required=False,
                 help=(
-                    "use with '--details' to omit the YellowDog IDs of objects from "
-                    "their JSON representations"
+                    "omit the YellowDog IDs of objects from their JSON "
+                    "representations, as well as other properties not "
+                    "required when capturing JSON for use with yd-create and yd-remove "
+                    "(implies '--details')"
                 ),
             )
 

{yellowdog_python_examples-7.18.3 → yellowdog_python_examples-7.18.4}/yellowdog_cli/utils/entity_utils.py

@@ -528,6 +528,33 @@ def substitute_ids_for_names_in_crt(
     return crt
 
 
+def substitute_image_family_id_for_name_in_cst(
+    client: PlatformClient, cst: ComputeSourceTemplate
+) -> ComputeSourceTemplate:
+    """
+    Substitute Image Family IDs for namespace/name,
+    if option is selected.
+    """
+
+    if not ARGS_PARSER.substitute_ids:
+        return cst
+
+    try:
+        cst.source.imageId = _get_image_family_name_from_id(client, cst.source.imageId)
+        return cst
+    except:
+        pass
+
+    try:
+        # Google uses a different property name
+        cst.source.image = _get_image_family_name_from_id(client, cst.source.image)
+        return cst
+    except:
+        pass
+
+    return cst
+
+
 @lru_cache
 def _get_source_template_name_from_id(
     client: PlatformClient, cst_id: Optional[str]

{yellowdog_python_examples-7.18.3 → yellowdog_python_examples-7.18.4}/yellowdog_cli/utils/load_config.py

@@ -118,7 +118,10 @@ def load_config_common() -> ConfigCommon:
         ]:
             if args_parser_value is not None:
                 common_section[key_name] = args_parser_value
-                print_log(f"Using '{key_name}' provided on command line")
+                print_log(
+                    f"Using '{key_name}' provided on command line "
+                    "(or automatically set)"
+                )
             elif os.environ.get(env_var_name, None) is not None:
                 common_section[key_name] = os.environ[env_var_name]
                 print_log(f"Using '{key_name}' provided via the environment")

{yellowdog_python_examples-7.18.3 → yellowdog_python_examples-7.18.4}/yellowdog_cli/utils/printing.py

@@ -73,7 +73,10 @@ from yellowdog_cli.utils.settings import (
     NAMESPACE_OBJECT_STORE_PREFIX_SEPARATOR,
     PROP_CREATED_TIME,
     PROP_ID,
+    PROP_INSTANCE_PRICING,
     PROP_RESOURCE,
+    PROP_SUPPORTING_RESOURCE_CREATED,
+    PROP_TRAITS,
     WARNING_STYLE,
 )
 from yellowdog_cli.utils.ydid_utils import YDIDType
@@ -1067,16 +1070,22 @@ def print_yd_object(
 
     def remove_unused_props(d):
         """
-        Helper function to remove the 'id' and 'createdTime' properties
-        recursively.
+        Helper function to remove the 'id' and other properties
+        not required for 'yd-create' and 'yd-remove', recursively.
         """
         if isinstance(d, dict):
-            # Create a new dictionary omitting the 'id' and 'createdTime'
-            # keys
+            # Create a new dictionary omitting redundant properties
             return {
                 k: remove_unused_props(v)
                 for k, v in d.items()
-                if k not in [PROP_ID, PROP_CREATED_TIME]
+                if k
+                not in [
+                    PROP_ID,
+                    PROP_CREATED_TIME,
+                    PROP_INSTANCE_PRICING,
+                    PROP_SUPPORTING_RESOURCE_CREATED,
+                    PROP_TRAITS,
+                ]
             }
         elif isinstance(d, list):
             # Recursively process each item in the list

{yellowdog_python_examples-7.18.3 → yellowdog_python_examples-7.18.4}/yellowdog_cli/utils/settings.py

@@ -146,6 +146,7 @@ PROP_ID = "id"
 PROP_IMAGE = "image"
 PROP_IMAGES_ID = "imagesId"
 PROP_IMAGE_ID = "imageId"
+PROP_INSTANCE_PRICING = "instancePricing"
 PROP_KEYRING = "keyring"
 PROP_KEYRING_NAME = "keyringName"
 PROP_NAME = "name"
@@ -159,6 +160,8 @@ PROP_ROLES = "roles"
 PROP_SOURCE = "source"
 PROP_SOURCES = "sources"
 PROP_SOURCE_CREATED_FROM = "sourceCreatedFromId"
+PROP_SUPPORTING_RESOURCE_CREATED = "supportingResourceCreated"
 PROP_TITLE = "title"
+PROP_TRAITS = "traits"
 PROP_TYPE = "type"
 PROP_UNITS = "units"

{yellowdog_python_examples-7.18.3 → yellowdog_python_examples-7.18.4/yellowdog_python_examples.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yellowdog-python-examples
-Version: 7.18.3
+Version: 7.18.4
 Summary: Python CLI commands using the YellowDog Python SDK
 Author-email: YellowDog Limited <support@yellowdog.co>
 Project-URL: Homepage, https://github.com/yellowdog/python-examples

yellowdog_python_examples-7.18.3/yellowdog_cli/__init__.py

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