Added example script list_partitions_partial_and_full.py

Details:

* Added a new example script list_partitions_partial_and_full.py that
  measures the elapsed time for listing partitions of a CPC with and without
  full properties.

Signed-off-by: Andreas Maier <maiera@de.ibm.com>

examples/list_partitions_partial_and_full.py

@@ -0,0 +1,87 @@
+#!/usr/bin/env python
+# Copyright 2023 IBM Corp. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""
+Example that lists partitions with partial and full properties to show timing
+difference.
+"""
+
+import sys
+import requests.packages.urllib3
+from datetime import datetime
+
+import zhmcclient
+from zhmcclient.testutils import hmc_definitions
+
+requests.packages.urllib3.disable_warnings()
+
+# Get HMC info from HMC inventory and vault files
+hmc_def = hmc_definitions()[0]
+nickname = hmc_def.nickname
+host = hmc_def.host
+userid = hmc_def.userid
+password = hmc_def.password
+verify_cert = hmc_def.verify_cert
+
+print(__doc__)
+
+print("Using HMC {} at {} with userid {} ...".format(nickname, host, userid))
+
+print("Creating a session with the HMC ...")
+try:
+    session = zhmcclient.Session(
+        host, userid, password, verify_cert=verify_cert)
+except zhmcclient.Error as exc:
+    print("Error: Cannot establish session with HMC {}: {}: {}".
+          format(host, exc.__class__.__name__, exc))
+    sys.exit(1)
+
+try:
+    client = zhmcclient.Client(session)
+
+    try:
+        cpc_name = sys.argv[1]
+    except IndexError:
+        cpc_name = None
+    if cpc_name:
+        cpc = client.cpcs.find(name=cpc_name)
+        print("Using specified CPC {}".format(cpc.name))
+    else:
+        cpcs = client.cpcs.list()
+        cpc = cpcs[0]
+        print("Using first CPC {}".format(cpc.name))
+
+    for full_properties in (False, True):
+        print("\nListing partitions with full_properties={} ...".
+              format(full_properties))
+        start_dt = datetime.now()
+        partitions = cpc.partitions.list(full_properties)
+        end_dt = datetime.now()
+        duration = end_dt - start_dt
+        non_stopped_partitions = [p for p in partitions
+                                  if p.properties['status'] != 'stopped']
+        num_props = 0
+        for partition in partitions:
+            num_props += len(partition.properties)
+        print("Duration: {:.2f} s".format(duration.total_seconds()))
+        print("Number of partitions: {}".format(len(partitions)))
+        print("Number of non-stopped partitions: {}".
+              format(len(non_stopped_partitions)))
+        print("Average number of properties per partition: {:.1f}".
+              format(num_props / len(partitions)))
+
+finally:
+    print("Logging off ...")
+    session.logoff()