yellowdog-python-examples 7.9.0__tar.gz → 7.9.1__tar.gz

{yellowdog_python_examples-7.9.0/yellowdog_python_examples.egg-info → yellowdog_python_examples-7.9.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: yellowdog-python-examples
-Version: 7.9.0
+Version: 7.9.1
 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.0 → yellowdog_python_examples-7.9.1}/README.md

@@ -87,7 +87,9 @@
    * [Namespace Storage Configurations](#namespace-storage-configurations)
    * [Configured Worker Pools](#configured-worker-pools)
    * [Allowances](#allowances)
-   * [String Attribute Definitions](#string-attribute-definitions)
+   * [Attribute Definitions](#attribute-definitions)
+      * [String Attribute Definitions](#string-attribute-definitions)
+      * [Numeric Attribute Definitions](#numeric-attribute-definitions)
 * [Jsonnet Support](#jsonnet-support)
    * [Jsonnet Installation](#jsonnet-installation)
    * [Variable Substitutions in Jsonnet Files](#variable-substitutions-in-jsonnet-files)
@@ -115,7 +117,7 @@
    * [yd-boost](#yd-boost)
 
 <!-- Created by https://github.com/ekalinin/github-markdown-toc -->
-<!-- Added by: pwt, at: Wed May  8 16:37:54 BST 2024 -->
+<!-- Added by: pwt, at: Thu May  9 16:47:20 BST 2024 -->
 
 <!--te-->
 
@@ -2163,9 +2165,11 @@ When using `yd-remove`, Allowances are again matched using their `description` p
 
 Allowances can be **boosted** (have extra hours added to the Allowance) using the `yd-boost` command.
 
-## String Attribute Definitions
+## Attribute Definitions
 
-The Attribute Definition example and schema can be found at: https://docs.yellowdog.co/api/?spec=Compute%20API#tag/compute/post/compute/attributes/user. Currently, only **String Attribute Definitions** are supported.
+The Attribute Definition example and schema can be found at: https://docs.yellowdog.co/api/?spec=Compute%20API#tag/compute/post/compute/attributes/user.
+
+### String Attribute Definitions
 
 Example:
 
@@ -2181,6 +2185,24 @@ Example:
 
 The `name` and `title` properties are required, while the rest are optional. The `user.` prefix is required when specifying the `name` property.
 
+### Numeric Attribute Definitions
+
+Example:
+
+```json
+{
+  "resource": "NumericAttributeDefinition",
+  "name": "my-numeric-attribute",
+  "title": "Attribute Title",
+  "defaultRankOrder": "PREFER_LOWER",
+  "description": "A description of the attribute",
+  "units": "$",
+  "range": {"min": 1, "max": 10}
+}
+```
+
+The `name`, `title` and `defaultRankOrder` properties are required, while the rest are optional. The `user.` prefix is required when specifying the `name` property.
+
 # Jsonnet Support
 
 In all circumstances where JSON files are used by the Python Examples commands,  **[Jsonnet](https://jsonnet.org)** files can be used instead. This allows the use of Jsonnet's powerful JSON extensions, including comments, variables, functions, etc.

yellowdog_python_examples-7.9.1/yd_commands/__init__.py

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

{yellowdog_python_examples-7.9.0 → yellowdog_python_examples-7.9.1}/yd_commands/args.py

@@ -529,6 +529,13 @@ class CLIParser:
                 required=False,
                 help="list allowances",
             )
+            parser.add_argument(
+                "--attribute-definitions",
+                "-R",
+                action="store_true",
+                required=False,
+                help="list attribute definitions",
+            )
 
         if any(module in sys.argv[0] for module in ["upload"]):
             parser.add_argument(
@@ -1310,6 +1317,11 @@ class CLIParser:
     def allowances(self) -> Optional[bool]:
         return self.args.allowances
 
+    @property
+    @allow_missing_attribute
+    def attribute_definitions(self) -> Optional[bool]:
+        return self.args.attribute_definitions
+
     @property
     @allow_missing_attribute
     def show_keyring_passwords(self) -> Optional[bool]:

{yellowdog_python_examples-7.9.0 → yellowdog_python_examples-7.9.1}/yd_commands/create.py

@@ -51,6 +51,7 @@ from yd_commands.settings import (
     RN_CREDENTIAL,
     RN_IMAGE_FAMILY,
     RN_KEYRING,
+    RN_NUMERIC_ATTRIBUTE_DEFINITION,
     RN_REQUIREMENT_TEMPLATE,
     RN_SOURCE_TEMPLATE,
     RN_STORAGE_CONFIGURATION,
@@ -119,8 +120,11 @@ def create_resources(
                 create_configured_worker_pool(resource)
             elif resource_type == RN_ALLOWANCE:
                 create_allowance(resource)
-            elif resource_type == RN_STRING_ATTRIBUTE_DEFINITION:
-                create_string_attribute_definition_via_api(resource)
+            elif resource_type in [
+                RN_STRING_ATTRIBUTE_DEFINITION,
+                RN_NUMERIC_ATTRIBUTE_DEFINITION,
+            ]:
+                create_attribute_definition_via_api(resource, resource_type)
             else:
                 print_error(f"Unknown resource type '{resource_type}'")
         except Exception as e:
@@ -792,40 +796,54 @@ def _get_model_class(class_name: str):
     return getattr(model, class_name)
 
 
-def create_string_attribute_definition_via_api(resource: Dict):
+def create_attribute_definition_via_api(resource: Dict, resource_type: str):
     """
-    Use the API to create/update user string attribute definitions.
+    Use the API to create/update user attribute definitions.
     """
     try:
         name = resource["name"]
         title = resource["title"]
+        if resource_type == RN_NUMERIC_ATTRIBUTE_DEFINITION:
+            default_rank_order = resource["defaultRankOrder"]
     except KeyError as e:
         raise Exception(f"Expected property to be defined ({e})")
 
     url = f"{CONFIG_COMMON.url}/compute/attributes/user"
     headers = {"Authorization": f"yd-key {CONFIG_COMMON.key}:{CONFIG_COMMON.secret}"}
-    payload = {
-        "name": name,
-        "title": title,
-        "type": "co.yellowdog.platform.model.StringAttributeDefinition",
-        "description": resource.get("description", ""),
-        "options": resource.get("options", []),
-    }
+    if resource_type == RN_STRING_ATTRIBUTE_DEFINITION:
+        payload = {
+            "type": "co.yellowdog.platform.model.StringAttributeDefinition",
+            "name": name,
+            "title": title,
+            "description": resource.get("description"),
+            "options": resource.get("options"),
+        }
+    else:  # RN_NUMERIC_ATTRIBUTE_DEFINITION
+        payload = {
+            "type": "co.yellowdog.platform.model.NumericAttributeDefinition",
+            "name": name,
+            "title": title,
+            "defaultRankOrder": default_rank_order,
+            "description": resource.get("description"),
+            "units": resource.get("units"),
+            "range": resource.get("range"),
+        }
 
     # Attempt attribute creation
+    print_log(f"Attempting to create or update Attribute Definition '{name}'")
     response = post(url=url, headers=headers, json=payload)
 
     if response.status_code == 200:
-        print_log(f"Created new String Attribute Definition '{name}'")
+        print_log(f"Created new Attribute Definition '{name}'")
         return
 
     if "Attribute already exists" in response.text:
-        if not confirmed(f"Update existing String Attribute Definition '{name}'?"):
+        if not confirmed(f"Update existing Attribute Definition '{name}'?"):
             return
 
         response = put(url=url, headers=headers, json=payload)
         if response.status_code == 200:
-            print_log(f"Updated existing String Attribute Definition '{name}'")
+            print_log(f"Updated existing Attribute Definition '{name}'")
             return
 
     raise Exception(f"HTTP {response.status_code} ({response.text})")

{yellowdog_python_examples-7.9.0 → yellowdog_python_examples-7.9.1}/yd_commands/interactive.py

@@ -3,7 +3,7 @@ User interaction processing utilities.
 """
 
 from os import getenv
-from typing import List, Optional, Set, Union
+from typing import Dict, List, Optional, Set, Union
 
 from yellowdog_client import PlatformClient
 
@@ -30,13 +30,14 @@ YD_YES = "YD_YES"
 
 def select(
     client: PlatformClient,
-    objects: List[Union[Item, str]],
+    objects: List[Union[Item, str, Dict]],
     object_type_name: Optional[str] = None,
     override_quiet: bool = False,
     single_result: bool = False,
     showing_all: bool = False,
     force_interactive: bool = False,
     result_required: bool = False,
+    sort_objects: bool = True,
 ) -> List[Item]:
     """
     Print a numbered list of objects.
@@ -47,7 +48,8 @@ def select(
     if len(objects) == 0:
         return objects
 
-    objects = sorted_objects(objects)
+    if sort_objects:
+        objects = sorted_objects(objects)
 
     if not ARGS_PARSER.quiet or override_quiet or ARGS_PARSER.interactive:
         print_numbered_object_list(

{yellowdog_python_examples-7.9.0 → yellowdog_python_examples-7.9.1}/yd_commands/list.py

@@ -5,6 +5,7 @@ Command to list YellowDog entities.
 """
 
 from dataclasses import asdict, fields
+from json import loads as json_loads
 from typing import Dict, List
 
 from requests import get
@@ -47,6 +48,7 @@ from yd_commands.object_utilities import (
 )
 from yd_commands.printing import (
     indent,
+    print_json,
     print_log,
     print_numbered_object_list,
     print_table_core,
@@ -85,6 +87,8 @@ def main():
         list_namespaces()
     elif ARGS_PARSER.allowances:
         list_allowances()
+    elif ARGS_PARSER.attribute_definitions:
+        list_attribute_definitions()
 
 
 def check_for_valid_option() -> bool:
@@ -105,6 +109,7 @@ def check_for_valid_option() -> bool:
         ARGS_PARSER.namespace_storage_configurations,
         ARGS_PARSER.instances,
         ARGS_PARSER.allowances,
+        ARGS_PARSER.attribute_definitions,
     ].count(True) == 1:
         return True
     else:
@@ -568,6 +573,39 @@ def list_allowances():
         print_yd_object(allowance)
 
 
+def list_attribute_definitions():
+    """
+    List user compute attribute definitions using the API.
+    """
+    response = get(
+        url=f"{CONFIG_COMMON.url}/compute/attributes/user",
+        headers={"Authorization": f"yd-key {CONFIG_COMMON.key}:{CONFIG_COMMON.secret}"},
+    )
+
+    if response.status_code != 200:
+        raise Exception(
+            "Unable to list user attribute definitions: HTTP "
+            f"{response.status_code} ({response.text})"
+        )
+
+    attribute_definition_list = json_loads(response.text)
+    attribute_definition_list.sort(key=lambda x: x["name"])
+
+    if not ARGS_PARSER.details:
+        print_numbered_object_list(
+            CLIENT, attribute_definition_list, object_type_name="Attribute Definition"
+        )
+        return
+
+    for selected_attribute_definition in select(
+        CLIENT,
+        attribute_definition_list,
+        object_type_name="Attribute Definition",
+        sort_objects=False,
+    ):
+        print_json(selected_attribute_definition)
+
+
 # Entry point
 if __name__ == "__main__":
     main()

{yellowdog_python_examples-7.9.0 → yellowdog_python_examples-7.9.1}/yd_commands/load_resources.py

@@ -13,6 +13,7 @@ from yd_commands.settings import (
     RN_CREDENTIAL,
     RN_IMAGE_FAMILY,
     RN_KEYRING,
+    RN_NUMERIC_ATTRIBUTE_DEFINITION,
     RN_REQUIREMENT_TEMPLATE,
     RN_SOURCE_TEMPLATE,
     RN_STORAGE_CONFIGURATION,
@@ -96,6 +97,7 @@ def _resequence_resources(
         RN_CREDENTIAL,
         RN_IMAGE_FAMILY,
         RN_STRING_ATTRIBUTE_DEFINITION,
+        RN_NUMERIC_ATTRIBUTE_DEFINITION,
         RN_SOURCE_TEMPLATE,
         RN_REQUIREMENT_TEMPLATE,
         RN_ALLOWANCE,

{yellowdog_python_examples-7.9.0 → yellowdog_python_examples-7.9.1}/yd_commands/printing.py

@@ -552,6 +552,30 @@ def allowances_table(
     return headers, table
 
 
+def attribute_definitions_table(
+    attribute_definitions: List[Dict],
+) -> (List[str], List[str]):
+    headers = [
+        "#",
+        "Name",
+        "Type",
+        "Title",
+        "Description",
+    ]
+    table = []
+    for index, attribute_definition in enumerate(attribute_definitions):
+        table.append(
+            [
+                index + 1,
+                attribute_definition["name"],
+                attribute_definition["type"].split(".")[-1],
+                attribute_definition["title"],
+                attribute_definition.get("description", ""),
+            ]
+        )
+    return headers, table
+
+
 def aws_availability_zone_table(
     aws_azs: List[AWSAvailabilityZone],
 ) -> (List[str], List[str]):
@@ -576,7 +600,7 @@ def aws_availability_zone_table(
 
 def print_numbered_object_list(
     client: PlatformClient,
-    objects: List[Union[Item, str]],
+    objects: List[Union[Item, str, Dict]],
     object_type_name: Optional[str] = None,
     override_quiet: bool = False,
     showing_all: bool = False,
@@ -626,6 +650,8 @@ def print_numbered_object_list(
         headers, table = allowances_table(objects)
     elif isinstance(objects[0], AWSAvailabilityZone):
         headers, table = aws_availability_zone_table(objects)
+    elif object_type_name == "Attribute Definition":
+        headers, table = attribute_definitions_table(objects)
     else:
         table = []
         for index, obj in enumerate(objects):

{yellowdog_python_examples-7.9.0 → yellowdog_python_examples-7.9.1}/yd_commands/remove.py

@@ -32,6 +32,7 @@ from yd_commands.settings import (
     RN_CREDENTIAL,
     RN_IMAGE_FAMILY,
     RN_KEYRING,
+    RN_NUMERIC_ATTRIBUTE_DEFINITION,
     RN_REQUIREMENT_TEMPLATE,
     RN_SOURCE_TEMPLATE,
     RN_STORAGE_CONFIGURATION,
@@ -94,8 +95,11 @@ def remove_resources(resources: Optional[List[Dict]] = None):
                         "alternatively, Allowances can be removed by their "
                         "YellowDog IDs (yd-remove --ids)"
                     )
-            elif resource_type == RN_STRING_ATTRIBUTE_DEFINITION:
-                remove_string_attribute_definition_via_api(resource)
+            elif resource_type in [
+                RN_STRING_ATTRIBUTE_DEFINITION,
+                RN_NUMERIC_ATTRIBUTE_DEFINITION,
+            ]:
+                remove_attribute_definition_via_api(resource)
             else:
                 print_error(f"Unknown resource type '{resource_type}'")
         except Exception as e:
@@ -411,7 +415,7 @@ def remove_resource_by_id(resource_id: str):
         print_error(f"Unable to remove resource with ID {resource_id}: {e}")
 
 
-def remove_string_attribute_definition_via_api(resource: Dict):
+def remove_attribute_definition_via_api(resource: Dict):
     """
     Use the API to remove user string attribute definitions.
     """
@@ -420,7 +424,7 @@ def remove_string_attribute_definition_via_api(resource: Dict):
     except KeyError as e:
         raise Exception(f"Expected property to be defined ({e})")
 
-    if not confirmed(f"Remove String Attribute Definition '{name}'?"):
+    if not confirmed(f"Remove Attribute Definition '{name}'?"):
         return
 
     url = f"{CONFIG_COMMON.url}/compute/attributes/user/{name}"
@@ -428,7 +432,7 @@ def remove_string_attribute_definition_via_api(resource: Dict):
     response = delete(url=url, headers=headers)
 
     if response.status_code == 200:
-        print_log(f"Removed String Attribute Definition '{name}' (if present)")
+        print_log(f"Removed Attribute Definition '{name}' (if present)")
         return
 
     raise Exception(f"HTTP {response.status_code} ({response.text})")

{yellowdog_python_examples-7.9.0 → yellowdog_python_examples-7.9.1}/yd_commands/settings.py

@@ -106,3 +106,4 @@ RN_REQUIREMENT_TEMPLATE = "ComputeRequirementTemplate"
 RN_SOURCE_TEMPLATE = "ComputeSourceTemplate"
 RN_STORAGE_CONFIGURATION = "NamespaceStorageConfiguration"
 RN_STRING_ATTRIBUTE_DEFINITION = "StringAttributeDefinition"
+RN_NUMERIC_ATTRIBUTE_DEFINITION = "NumericAttributeDefinition"

{yellowdog_python_examples-7.9.0 → yellowdog_python_examples-7.9.1/yellowdog_python_examples.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: yellowdog-python-examples
-Version: 7.9.0
+Version: 7.9.1
 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.0/yd_commands/__init__.py

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