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

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

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

@@ -1275,7 +1275,7 @@ where <working_directory> is:
   /var/opt/yellowdog/agent/data/workers/ydid_task_D0D0D0_68f5e5be-dc93-49eb-a824-1fcdb52f9195_1_1/
 ```
 
-Note that the Work Requirement name is automatically made available to the Task via the environment variable `YD_WORK_REQUIREMENT_NAME`, by `yd-submit`. It's also available for client-side variable substitution in Work Requirements using the variable `{{wr_name}}`.
+Note that the Work Requirement name is automatically made available to the Task via the environment variable `YD_WORK_REQUIREMENT_NAME`, by `yd-submit`, if the `addYDEnvironmentVariables` property is set to `true`. It's also available for client-side variable substitution in Work Requirements using the variable `{{wr_name}}`.
 
 ### Files Uploaded from a Node to the Object Store after Task Execution
 
@@ -1350,7 +1350,7 @@ This section discusses the context within which a Task operates when it's execut
 
 When a Task is allocated to a Worker on a node by the YellowDog Scheduler, the following steps are followed:
 
-1. The Agent running on the node downloads the Task's properties: its `taskType`,  `arguments`, `environment`, `taskdata`, and (from the Object Store) any files in the `inputs` list and any available files in the `inputsOptional` list. A number of `YD_` environment variables are also automatically set by a combination of `yd_submit` and the Agent itself -- see above for details.
+1. The Agent running on the node downloads the Task's properties: its `taskType`,  `arguments`, `environment`, `taskdata`, and (from the Object Store) any files in the `inputs` list and any available files in the `inputsOptional` list. A number of `YD_` environment variables are also automatically set by a combination (optionally) of `yd_submit`, and the Agent itself -- see above for details.
 2. The downloaded files are placed in an ephemeral directory created for this Task's execution, and into which any output files are also written by default.
 2. The Agent runs the command specified for the `taskType` in the Agent's `application.yaml` configuration file. This done as a simple `exec` of a subprocess to run the Task.
 3. When the Task concludes, the Agent uses the exit code of the subprocess to report success (zero) or failure (non-zero).
@@ -2192,7 +2192,7 @@ Example:
 ```json
 {
   "resource": "NumericAttributeDefinition",
-  "name": "my-numeric-attribute",
+  "name": "user.my-numeric-attribute",
   "title": "Attribute Title",
   "defaultRankOrder": "PREFER_LOWER",
   "description": "A description of the attribute",
@@ -2201,7 +2201,7 @@ Example:
 }
 ```
 
-The `name`, `title` and `defaultRankOrder` properties are required, while the rest are optional. The `user.` prefix is required when specifying the `name` property.
+The `name`, `title` and `defaultRankOrder` properties are required, while the rest are optional. Either the `range` property or the `options` property (with numeric option values) can be specified, but not both. The `user.` prefix is required when specifying the `name` property.
 
 # Jsonnet Support
 

{yellowdog_python_examples-7.9.1 → yellowdog_python_examples-7.9.3}/tests/test_demos.py

@@ -61,6 +61,10 @@ class TestDemos:
         result = shell(f"cd {DEMO_DIR}/montecarlo && {CMD_SEQ}")
         assert result.exit_code == 0
 
+    def test_ansys(self):
+        result = shell(f"cd {DEMO_DIR}/ansys && {CMD_SEQ}")
+        assert result.exit_code == 0
+
     def test_nextflow_image_montage(self):
         result = shell(
             f"cd {DEMO_DIR}/nextflow/image-montage && {NEXTFLOW} main.nf "

{yellowdog_python_examples-7.9.1 → yellowdog_python_examples-7.9.3}/tests/test_dryruns.py

@@ -64,6 +64,10 @@ class TestDemoDryRuns:
         result = shell(f"cd {DEMO_DIR}/montecarlo && {CMD_SEQ}")
         assert result.exit_code == 0
 
+    def test_ansys(self):
+        result = shell(f"cd {DEMO_DIR}/ansys && {CMD_SEQ}")
+        assert result.exit_code == 0
+
     # Tests run from outside the demo directories
     def test_bash_out(self):
         demo_name = "bash"
@@ -182,3 +186,12 @@ class TestDemoDryRuns:
             f" {demo_name}/config.toml"
         )
         assert result.exit_code == 0
+
+    def test_ansys_out(self):
+        demo_name = "ansys"
+        result = shell(
+            f"cd {DEMO_DIR} && yd-provision -D -c {demo_name}/config.toml && yd-submit"
+            f" -D -c {demo_name}/config.toml && yd-instantiate -D -c"
+            f" {demo_name}/config.toml"
+        )
+        assert result.exit_code == 0

yellowdog_python_examples-7.9.3/yd_commands/__init__.py

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

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

@@ -534,7 +534,7 @@ class CLIParser:
                 "-R",
                 action="store_true",
                 required=False,
-                help="list attribute definitions",
+                help="list user attribute definitions",
             )
 
         if any(module in sys.argv[0] for module in ["upload"]):

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

@@ -124,7 +124,7 @@ def create_resources(
                 RN_STRING_ATTRIBUTE_DEFINITION,
                 RN_NUMERIC_ATTRIBUTE_DEFINITION,
             ]:
-                create_attribute_definition_via_api(resource, resource_type)
+                create_attribute_definition(resource, resource_type)
             else:
                 print_error(f"Unknown resource type '{resource_type}'")
         except Exception as e:
@@ -796,7 +796,7 @@ def _get_model_class(class_name: str):
     return getattr(model, class_name)
 
 
-def create_attribute_definition_via_api(resource: Dict, resource_type: str):
+def create_attribute_definition(resource: Dict, resource_type: str):
     """
     Use the API to create/update user attribute definitions.
     """
@@ -812,21 +812,28 @@ def create_attribute_definition_via_api(resource: Dict, resource_type: str):
     headers = {"Authorization": f"yd-key {CONFIG_COMMON.key}:{CONFIG_COMMON.secret}"}
     if resource_type == RN_STRING_ATTRIBUTE_DEFINITION:
         payload = {
+            # Required
             "type": "co.yellowdog.platform.model.StringAttributeDefinition",
             "name": name,
             "title": title,
+            # Optional
             "description": resource.get("description"),
             "options": resource.get("options"),
         }
     else:  # RN_NUMERIC_ATTRIBUTE_DEFINITION
         payload = {
+            # Required
             "type": "co.yellowdog.platform.model.NumericAttributeDefinition",
             "name": name,
             "title": title,
             "defaultRankOrder": default_rank_order,
+            # Optional
             "description": resource.get("description"),
             "units": resource.get("units"),
+            # Note: Only one of 'range', 'options' can be supplied
+            # Allow the API to error-check
             "range": resource.get("range"),
+            "options": resource.get("options"),
         }
 
     # Attempt attribute creation

{yellowdog_python_examples-7.9.1 → yellowdog_python_examples-7.9.3}/yd_commands/delete.py

@@ -4,11 +4,8 @@
 A script to delete YellowDog Object Store items.
 """
 
-from typing import List, Optional
-
-from yellowdog_client.model import ObjectPath, ObjectPathsRequest
-
 from yd_commands.interactive import confirmed, select
+from yd_commands.object_utilities import list_matching_object_paths
 from yd_commands.printing import print_log
 from yd_commands.utils import unpack_namespace_in_prefix
 from yd_commands.wrapper import ARGS_PARSER, CLIENT, CONFIG_COMMON, main_wrapper
@@ -45,18 +42,13 @@ def delete_object_paths(namespace: str, prefix: str, flat: bool):
         f"prefix starting with '{prefix}'"
     )
 
-    object_paths_to_delete: Optional[List[ObjectPath]] = (
-        CLIENT.object_store_client.get_namespace_object_paths(
-            ObjectPathsRequest(namespace=namespace, prefix=prefix, flat=flat)
-        )
-    )
+    object_paths_to_delete = list_matching_object_paths(CLIENT, namespace, prefix, flat)
 
-    if object_paths_to_delete is None:
+    if len(object_paths_to_delete) == 0:
         print_log("No matching Object Paths")
         return
 
-    if len(object_paths_to_delete) > 0:
-        object_paths_to_delete = select(CLIENT, object_paths_to_delete)
+    object_paths_to_delete = select(CLIENT, object_paths_to_delete)
 
     if len(object_paths_to_delete) > 0 and confirmed(
         f"Delete {len(object_paths_to_delete)} Object Path(s)?"

{yellowdog_python_examples-7.9.1 → yellowdog_python_examples-7.9.3}/yd_commands/download.py

@@ -6,9 +6,8 @@ A script to download YellowDog Object Store objects.
 
 from concurrent import futures
 from pathlib import Path
-from typing import List, Optional
+from typing import Optional
 
-from yellowdog_client.model import ObjectPath, ObjectPathsRequest
 from yellowdog_client.object_store.download.download_batch_builder import (
     AbstractTransferBatch,
     DownloadBatchBuilder,
@@ -17,6 +16,7 @@ from yellowdog_client.object_store.download.download_batch_builder import (
 from yellowdog_client.object_store.model import FileTransferStatus
 
 from yd_commands.interactive import confirmed, select
+from yd_commands.object_utilities import list_matching_object_paths
 from yd_commands.printing import print_batch_download_files, print_log
 from yd_commands.utils import unpack_namespace_in_prefix
 from yd_commands.wrapper import ARGS_PARSER, CLIENT, CONFIG_COMMON, main_wrapper
@@ -58,14 +58,15 @@ def download_object_paths(
         + ("" if pattern is None else f", matching name pattern '{pattern}'")
     )
 
-    object_paths_to_download: List[ObjectPath] = (
-        CLIENT.object_store_client.get_namespace_object_paths(
-            ObjectPathsRequest(namespace=namespace, prefix=prefix, flat=flat)
-        )
+    object_paths_to_download = list_matching_object_paths(
+        CLIENT, namespace, prefix, flat
     )
 
-    if len(object_paths_to_download) > 0:
-        object_paths_to_download = select(CLIENT, object_paths_to_download)
+    if len(object_paths_to_download) == 0:
+        print_log("No matching Object Paths")
+        return
+
+    object_paths_to_download = select(CLIENT, object_paths_to_download)
 
     if len(object_paths_to_download) == 0:
         print_log("No Objects Paths to include")

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

@@ -29,8 +29,6 @@ from yellowdog_client.model import (
     MachineImageFamilySummary,
     NamespaceStorageConfiguration,
     ObjectDetail,
-    ObjectPath,
-    ObjectPathsRequest,
     Task,
     TaskGroup,
     TaskSearch,
@@ -45,6 +43,7 @@ from yd_commands.interactive import select
 from yd_commands.object_utilities import (
     get_filtered_work_requirements,
     get_task_groups_from_wr_summary,
+    list_matching_object_paths,
 )
 from yd_commands.printing import (
     indent,
@@ -210,19 +209,10 @@ def list_object_paths():
     if ARGS_PARSER.all and not ARGS_PARSER.details:
         print_log("Listing all Objects")
 
-    object_paths: List[ObjectPath] = (
-        CLIENT.object_store_client.get_namespace_object_paths(
-            ObjectPathsRequest(
-                namespace=namespace,
-                prefix=tag,
-                flat=ARGS_PARSER.all,
-            )
-        )
-    )
+    object_paths = list_matching_object_paths(CLIENT, namespace, tag, ARGS_PARSER.all)
 
-    # We shouldn't get a None return, but ...
-    if object_paths is None or len(object_paths) == 0:
-        print_log("No matching Object Paths found")
+    if len(object_paths) == 0:
+        print_log("No matching Object Paths")
         return
 
     if not ARGS_PARSER.details:

{yellowdog_python_examples-7.9.1 → yellowdog_python_examples-7.9.3}/yd_commands/load_config.py

@@ -150,6 +150,19 @@ def load_config_common() -> ConfigCommon:
         name_tag = process_variable_substitutions(common_section[NAME_TAG])
         add_substitutions_without_overwriting(subs={NAME_TAG: name_tag})
 
+        # Specify a certificates bundle directly by setting the requests
+        # environment variable; this will override the default certificates
+        certificates = process_variable_substitutions(
+            common_section.get(CERTIFICATES, None)
+        )
+        if certificates is not None:
+            certificates = abspath(certificates)
+            requests_ca_bundle = "REQUESTS_CA_BUNDLE"
+            print_log(
+                f"Setting environment variable '{requests_ca_bundle}' to '{certificates}'"
+            )
+            os.environ["REQUESTS_CA_BUNDLE"] = certificates
+
         return ConfigCommon(
             # Required
             key=key,

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

@@ -16,6 +16,8 @@ from yellowdog_client.model import (
     ComputeSourceTemplateSummary,
     MachineImageFamilySearch,
     MachineImageFamilySummary,
+    ObjectPath,
+    ObjectPathsRequest,
     ProvisionedWorkerPool,
     Task,
     TaskGroup,
@@ -279,3 +281,28 @@ def remove_allowances_matching_description(
             print_log(f"Removed Allowance with YellowDog ID {allowance.id}")
 
     return len(allowances)
+
+
+def list_matching_object_paths(
+    client: PlatformClient, namespace: str, prefix: str, flat: bool
+) -> List[ObjectPath]:
+    """
+    List object paths matching the namespace and starting with the prefix.
+    """
+    object_paths: List[ObjectPath] = (
+        client.object_store_client.get_namespace_object_paths(
+            ObjectPathsRequest(namespace=namespace, prefix=prefix, flat=flat)
+        )
+    )
+
+    if object_paths is None:
+        return []
+
+    # Check that the prefix actually matches!
+    object_paths = [
+        object_path
+        for object_path in object_paths
+        if object_path.name.startswith(prefix)
+    ]
+
+    return object_paths

{yellowdog_python_examples-7.9.1 → yellowdog_python_examples-7.9.3}/yd_commands/property_names.py

@@ -5,6 +5,7 @@ Property names.
 ADD_YD_ENV_VARS = "addYDEnvironmentVariables"
 ALWAYS_UPLOAD = "alwaysUpload"  # Bool
 ARGS = "arguments"  # List
+CERTIFICATES = "certificates"
 COMMON_SECTION = "common"  # No value
 COMPLETED_TASK_TTL = "completedTaskTtl"  # Float
 COMPUTE_REQUIREMENT_BATCH_SIZE = "computeRequirementBatchSize"  # Integer
@@ -102,6 +103,7 @@ ALL_KEYS = [
     ADD_YD_ENV_VARS,
     ALWAYS_UPLOAD,
     ARGS,
+    CERTIFICATES,
     COMMON_SECTION,
     COMPLETED_TASK_TTL,
     COMPUTE_REQUIREMENT_BATCH_SIZE,

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

@@ -99,7 +99,7 @@ def remove_resources(resources: Optional[List[Dict]] = None):
                 RN_STRING_ATTRIBUTE_DEFINITION,
                 RN_NUMERIC_ATTRIBUTE_DEFINITION,
             ]:
-                remove_attribute_definition_via_api(resource)
+                remove_attribute_definition(resource)
             else:
                 print_error(f"Unknown resource type '{resource_type}'")
         except Exception as e:
@@ -415,9 +415,9 @@ def remove_resource_by_id(resource_id: str):
         print_error(f"Unable to remove resource with ID {resource_id}: {e}")
 
 
-def remove_attribute_definition_via_api(resource: Dict):
+def remove_attribute_definition(resource: Dict):
     """
-    Use the API to remove user string attribute definitions.
+    Use the API to remove user attribute definitions.
     """
     try:
         name = resource["name"]

{yellowdog_python_examples-7.9.1 → yellowdog_python_examples-7.9.3}/yd_commands/submit.py

@@ -411,7 +411,10 @@ def create_task_group(
     if config_wr.task_type is not None and len(task_types) == 0:
         task_types.append(config_wr.task_type)
     if len(task_types) == 0:
-        raise Exception(f"No Task Type(s) specified in Task Group '{task_group_name}'")
+        raise Exception(
+            f"No Task Type(s) specified in Task Group '{task_group_name}': "
+            "is a valid Work Requirement defined?"
+        )
 
     vcpus_data: Optional[List[float]] = check_list(
         task_group_data.get(VCPUS, wr_data.get(VCPUS, config_wr.vcpus))

{yellowdog_python_examples-7.9.1 → yellowdog_python_examples-7.9.3}/yd_commands/upload_utils.py

@@ -10,7 +10,7 @@ from typing import Optional
 from yellowdog_client import PlatformClient
 from yellowdog_client.object_store.model import FileTransferStatus
 
-from yd_commands.printing import print_error, print_log
+from yd_commands.printing import print_log
 from yd_commands.settings import NAMESPACE_PREFIX_SEPARATOR
 from yd_commands.utils import link
 

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

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

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