yellowdog-python-examples 8.2.1__py3-none-any.whl → 8.3.1__py3-none-any.whl

yellowdog_cli/__init__.py

@@ -1 +1 @@
-__version__ = "8.2.1"
+__version__ = "8.3.1"

yellowdog_cli/abort.py

@@ -21,7 +21,7 @@ from yellowdog_cli.utils.entity_utils import (
 from yellowdog_cli.utils.interactive import confirmed, select
 from yellowdog_cli.utils.printing import (
     print_error,
-    print_log,
+    print_info,
     print_warning,
     sorted_objects,
 )
@@ -36,7 +36,7 @@ def main():
         _abort_tasks_by_name_or_id(ARGS_PARSER.task_id_list)
         return
 
-    print_log(
+    print_info(
         "Finding active Work Requirements in "
         f"namespace '{CONFIG_COMMON.namespace}' with tags "
         f"including '{CONFIG_COMMON.name_tag}'"
@@ -66,7 +66,7 @@ def main():
             override_quiet=True,
         )
     else:
-        print_log("No matching Work Requirements found")
+        print_info("No matching Work Requirements found")
 
     if len(selected_work_requirement_summaries) == 1:
         abort_tasks_selectively(selected_work_requirement_summaries[0])
@@ -78,7 +78,7 @@ def abort_tasks_selectively(
     """
     Abort selected Tasks in a Work Requirements
     """
-    print_log(f"Aborting Tasks in Work Requirement '{wr_summary.name}'")
+    print_info(f"Aborting Tasks in Work Requirement '{wr_summary.name}'")
 
     task_search = TaskSearch(
         workRequirementId=wr_summary.id,
@@ -91,7 +91,7 @@ def abort_tasks_selectively(
             CLIENT, sorted_objects(tasks), parent=wr_summary, override_quiet=True
         )
     else:
-        print_log(
+        print_info(
             "No currently executing Tasks in this Work Requirement",
             override_quiet=True,
         )
@@ -101,7 +101,7 @@ def abort_tasks_selectively(
         for task in tasks:
             try:
                 CLIENT.work_client.cancel_task(task, abort=True)
-                print_log(
+                print_info(
                     f"Aborted Task '{task.name}' in Task Group"
                     f" '{get_task_group_name(CLIENT, wr_summary, task)}' in Work"
                     f" Requirement '{wr_summary.name}'"
@@ -111,9 +111,9 @@ def abort_tasks_selectively(
                 print_error(f"Unable to abort Task '{task.name}': {e}")
 
     if aborted_tasks == 0:
-        print_log("No Tasks Aborted")
+        print_info("No Tasks Aborted")
     elif aborted_tasks > 1:
-        print_log(f"Aborted {aborted_tasks} Tasks")
+        print_info(f"Aborted {aborted_tasks} Tasks")
 
 
 def _abort_tasks_by_name_or_id(task_id_list: List[str]):
@@ -131,15 +131,15 @@ def _abort_tasks_by_name_or_id(task_id_list: List[str]):
 
         try:
             CLIENT.work_client.cancel_task_by_id(task_id, abort=True)
-            print_log(f"Cancelled and aborted Task '{task_id}'")
+            print_info(f"Cancelled and aborted Task '{task_id}'")
             aborted_count += 1
         except Exception as e:
             print_error(f"Unable to cancel and abort Task '{task_id}': {e}")
 
     if aborted_count > 1:
-        print_log(f"Cancelled and aborted {aborted_count} Tasks")
+        print_info(f"Cancelled and aborted {aborted_count} Tasks")
     elif aborted_count == 0:
-        print_log("No Tasks cancelled and aborted")
+        print_info("No Tasks cancelled and aborted")
 
 
 # Entry point

yellowdog_cli/admin.py

@@ -6,7 +6,7 @@ Skeleton CLI for admin commands (YellowDog only)
 
 import requests
 
-from yellowdog_cli.utils.printing import print_error, print_log
+from yellowdog_cli.utils.printing import print_error, print_info
 from yellowdog_cli.utils.wrapper import ARGS_PARSER, CONFIG_COMMON, main_wrapper
 
 
@@ -24,7 +24,7 @@ def main():
             },
         )
         if response.status_code == 200:
-            print_log(f"Refreshed Work Requirement '{wr_id}'")
+            print_info(f"Refreshed Work Requirement '{wr_id}'")
         else:
             print_error(f"Failed to refresh Work Requirement '{wr_id}'")
             raise Exception(f"{response.text}")

yellowdog_cli/application.py

@@ -0,0 +1,104 @@
+#!/usr/bin/env python3
+
+"""
+A script for reporting on the details of the Application being used.
+"""
+
+from yellowdog_client.model import ApplicationDetails
+
+from yellowdog_cli.utils.entity_utils import (
+    get_all_roles_and_namespaces_for_application,
+    get_application_details,
+    get_application_group_summaries,
+)
+from yellowdog_cli.utils.printing import print_simple
+from yellowdog_cli.utils.wrapper import CLIENT, CONFIG_COMMON, main_wrapper
+
+
+@main_wrapper
+def main():
+
+    application_details: ApplicationDetails = get_application_details(CLIENT)
+
+    print()
+    print_simple(
+        f"  Application name:                  {application_details.name}",
+        override_quiet=True,
+    )
+    print_simple(
+        f"  Application ID:                    {application_details.id}",
+        override_quiet=True,
+    )
+    print_simple(
+        f"  Account name:                      {application_details.accountName}",
+        override_quiet=True,
+    )
+    if "api" in CONFIG_COMMON.url:
+        print_simple(
+            "  Portal URL:                        "
+            f"{CONFIG_COMMON.url.replace('api', 'portal')}"
+            f"/#/signin?account={application_details.accountName}",
+            override_quiet=True,
+        )
+    print_simple(
+        f"  Account ID:                        {application_details.accountId}",
+        override_quiet=True,
+    )
+    features = (
+        ""
+        if application_details.features is None
+        else ", ".join([str(feature) for feature in application_details.features])
+    )
+    print_simple(
+        f"  Account features:                  {features}",
+        override_quiet=True,
+    )
+    all_ns_readable = "Yes" if application_details.allNamespacesReadable else "No"
+    print_simple(
+        f"  All namespaces readable:           {all_ns_readable}",
+        override_quiet=True,
+    )
+    if not application_details.allNamespacesReadable:
+        readable_namespaces = (
+            ""
+            if application_details.readableNamespaces is None
+            else ", ".join([rns for rns in application_details.readableNamespaces])
+        )
+        print_simple(
+            f"  Readable namespaces:               {readable_namespaces}",
+            override_quiet=True,
+        )
+    try:
+        groups = get_application_group_summaries(CLIENT, application_details.id)
+        group_names = ", ".join([group.name for group in groups])
+        print_simple(
+            f"  In group(s):                       {group_names}",
+            override_quiet=True,
+        )
+        for i, (role, namespaces) in enumerate(
+            get_all_roles_and_namespaces_for_application(
+                CLIENT, application_details.id
+            ).items()
+        ):
+            msg = f"{role} [{', '.join(namespaces)}]"
+            if i == 0:
+                print_simple(
+                    f"  With role(s) [in namespace(s)]:    {msg}",
+                    override_quiet=True,
+                )
+            else:
+                print_simple(
+                    f"                                     {msg}",
+                    override_quiet=True,
+                )
+
+    except Exception as e:
+        if "Forbidden" in str(e):
+            print_simple(
+                "  Groups and roles:                  "
+                "Cannot be determined due to application permissions",
+                override_quiet=True,
+            )
+        else:
+            pass
+    print()

yellowdog_cli/boost.py

@@ -5,7 +5,7 @@ A script to boost allowances.
 """
 
 from yellowdog_cli.utils.interactive import confirmed
-from yellowdog_cli.utils.printing import print_error, print_log, print_warning
+from yellowdog_cli.utils.printing import print_error, print_info, print_warning
 from yellowdog_cli.utils.wrapper import ARGS_PARSER, CLIENT, main_wrapper
 from yellowdog_cli.utils.ydid_utils import YDIDType, get_ydid_type
 
@@ -26,7 +26,7 @@ def main():
             CLIENT.allowances_client.boost_allowance_by_id(
                 allowance, ARGS_PARSER.boost_hours
             )
-            print_log(
+            print_info(
                 f"Boosted Allowance {allowance} by {ARGS_PARSER.boost_hours} hours"
             )
             count += 1
@@ -34,7 +34,7 @@ def main():
             print_error(f"Unable to boost Allowance {allowance}: {e}")
 
     if count > 1:
-        print_log(f"Boosted {count} allowances by {ARGS_PARSER.boost_hours} hours")
+        print_info(f"Boosted {count} allowances by {ARGS_PARSER.boost_hours} hours")
 
 
 # Standalone entry point

yellowdog_cli/cancel.py

@@ -19,7 +19,7 @@ from yellowdog_cli.utils.entity_utils import (
 from yellowdog_cli.utils.follow_utils import follow_ids
 from yellowdog_cli.utils.interactive import confirmed, select
 from yellowdog_cli.utils.misc_utils import link_entity
-from yellowdog_cli.utils.printing import print_error, print_log, print_warning
+from yellowdog_cli.utils.printing import print_error, print_info, print_warning
 from yellowdog_cli.utils.wrapper import ARGS_PARSER, CLIENT, CONFIG_COMMON, main_wrapper
 from yellowdog_cli.utils.ydid_utils import YDIDType, get_ydid_type
 
@@ -30,7 +30,7 @@ def main():
         _cancel_work_requirements_by_name_or_id(ARGS_PARSER.work_requirement_names)
         return
 
-    print_log(
+    print_info(
         "Cancelling Work Requirements in namespace "
         f"'{CONFIG_COMMON.namespace}' with tags "
         f"including '{CONFIG_COMMON.name_tag}'"
@@ -73,7 +73,7 @@ def main():
                         CLIENT.work_client.get_work_requirement_by_id(work_summary.id)
                     )
                     cancelled_count += 1
-                    print_log(
+                    print_info(
                         f"Cancelled {link_entity(CONFIG_COMMON.url, work_requirement)} "
                         f"('{work_summary.name}')"
                         f"{'' if not ARGS_PARSER.abort else ' and aborted all allocated tasks'}"
@@ -85,22 +85,22 @@ def main():
                     )
 
             elif work_summary.status == WorkRequirementStatus.CANCELLING:
-                print_log(
+                print_info(
                     f"Work Requirement '{work_summary.name}' is already cancelling"
                 )
                 cancelling_count += 1
             work_requirement_ids.append(work_summary.id)
 
         if cancelled_count > 1:
-            print_log(f"Cancelled {cancelled_count} Work Requirement(s)")
+            print_info(f"Cancelled {cancelled_count} Work Requirement(s)")
         elif cancelled_count == 0 and cancelling_count == 0:
-            print_log("No Work Requirements to cancel")
+            print_info("No Work Requirements to cancel")
 
         if ARGS_PARSER.follow:
             follow_ids(work_requirement_ids)
 
     else:
-        print_log("No Work Requirements to cancel")
+        print_info("No Work Requirements to cancel")
 
 
 def _cancel_work_requirements_by_name_or_id(names_or_ids: List[str]):
@@ -148,7 +148,7 @@ def _cancel_work_requirements_by_name_or_id(names_or_ids: List[str]):
 
         work_requirement_summaries.append(work_requirement_summary)
         if work_requirement_summary.status == WorkRequirementStatus.CANCELLING:
-            print_log(f"Work Requirement '{name_or_id}' is already cancelling")
+            print_info(f"Work Requirement '{name_or_id}' is already cancelling")
         else:
             if not confirmed(
                 f"Cancel Work Requirement '{name_or_id}'"
@@ -159,7 +159,7 @@ def _cancel_work_requirements_by_name_or_id(names_or_ids: List[str]):
                 CLIENT.work_client.cancel_work_requirement_by_id(
                     work_requirement_summary.id, ARGS_PARSER.abort
                 )
-                print_log(
+                print_info(
                     f"Cancelled Work Requirement '{name_or_id}'"
                     f"{'' if not ARGS_PARSER.abort else ' and aborted all allocated tasks'}"
                 )

yellowdog_cli/cloudwizard.py

@@ -8,7 +8,7 @@ from yellowdog_cli.utils.check_imports import check_cloudwizard_imports
 from yellowdog_cli.utils.cloudwizard_aws import AWSConfig
 from yellowdog_cli.utils.cloudwizard_azure import AzureConfig
 from yellowdog_cli.utils.cloudwizard_gcp import GCPConfig
-from yellowdog_cli.utils.printing import print_error, print_log, print_warning
+from yellowdog_cli.utils.printing import print_error, print_info, print_warning
 from yellowdog_cli.utils.wrapper import ARGS_PARSER, CLIENT, main_wrapper
 
 
@@ -21,7 +21,7 @@ def main():
     check_cloudwizard_imports()
 
     if ARGS_PARSER.cloud_provider.lower() in ["aws", "amazon"]:
-        print_log(f"YellowDog automated cloud provider setup/teardown for 'AWS'")
+        print_info(f"YellowDog automated cloud provider setup/teardown for 'AWS'")
         cloud_provider_config = AWSConfig(
             client=CLIENT,
             region_name=ARGS_PARSER.region_name,
@@ -30,7 +30,7 @@ def main():
         )
 
     elif ARGS_PARSER.cloud_provider.lower() in ["gcp", "gce", "google"]:
-        print_log(f"YellowDog automated cloud provider setup/teardown for 'GCP'")
+        print_info(f"YellowDog automated cloud provider setup/teardown for 'GCP'")
         if ARGS_PARSER.credentials_file is None:
             print_error(
                 "Credentials file ('--credentials-file') must be supplied for GCP"
@@ -43,7 +43,7 @@ def main():
         )
 
     elif ARGS_PARSER.cloud_provider.lower() in ["azure", "microsoft"]:
-        print_log(f"YellowDog automated cloud provider setup/teardown for 'Azure'")
+        print_info(f"YellowDog automated cloud provider setup/teardown for 'Azure'")
         cloud_provider_config = AzureConfig(
             client=CLIENT,
             instance_type=ARGS_PARSER.instance_type,

yellowdog_cli/compare.py

@@ -27,7 +27,7 @@ from yellowdog_client.model import (
 from yellowdog_cli.utils.entity_utils import get_worker_pool_by_id
 from yellowdog_cli.utils.printing import (
     indent,
-    print_log,
+    print_info,
     print_table_core,
     print_warning,
 )
@@ -134,7 +134,7 @@ class MatchReport:
             match_str = "MAYBE MATCHING"
         else:
             match_str = "NON-MATCHING"
-        print_log(
+        print_info(
             f"Detailed comparison report for {match_str} ({self.worker_pool_status}) Worker Pool "
             f"'{self.worker_pool_name}' ({self.worker_pool_id})",
             override_quiet=True,
@@ -634,7 +634,7 @@ def _compare_task_group(task_group: TaskGroup, worker_pools: WorkerPools):
     """
     Compare a Task Group.
     """
-    print_log(
+    print_info(
         f"Comparing Task Group '{task_group.name}' ({task_group.id})",
         override_quiet=True,
     )
@@ -645,7 +645,7 @@ def _compare_task_group(task_group: TaskGroup, worker_pools: WorkerPools):
 
     if len(match_reports) > 1:
         # Summary report
-        print_log("Summary of Worker Pool matches:", override_quiet=True)
+        print_info("Summary of Worker Pool matches:", override_quiet=True)
         header_row = [
             "",
             "Worker Pool Name",
@@ -675,7 +675,7 @@ def _compare_task_group(task_group: TaskGroup, worker_pools: WorkerPools):
     for match_report in match_reports:
         match_report.print_detailed_report()
 
-    print_log("Task Group comparison complete")
+    print_info("Task Group comparison complete")
 
 
 @main_wrapper
@@ -700,7 +700,7 @@ def main():
     # Work requirement
     elif get_ydid_type(ARGS_PARSER.wr_or_tg_id) == YDIDType.WORK_REQUIREMENT:
         work_requirement = _get_work_requirement_by_id(ARGS_PARSER.wr_or_tg_id)
-        print_log(
+        print_info(
             f"Comparing all Task Groups in Work Requirement '{work_requirement.name}' "
             f"({work_requirement.id})",
             override_quiet=True,