fb-vmware 1.5.3__py3-none-any.whl → 1.7.0__py3-none-any.whl

fb_vmware/app/get_storage_cluster_list.py

@@ -1,7 +1,7 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 """
-@summary: The module for the application object of the get-vsphere-storage-cluster-list application.
+@summary: Print a list of all storage clusters in a VMware vSphere.
 
 @author: Frank Brehm
 @contact: frank@brehm-online.com
@@ -10,7 +10,9 @@
 from __future__ import absolute_import, print_function
 
 # Standard modules
+import locale
 import logging
+import pathlib
 import sys
 from operator import itemgetter
 
@@ -23,19 +25,20 @@ from fb_tools.spinner import Spinner
 from fb_tools.xlate import format_list
 
 # Own modules
-from . import BaseVmwareApplication, VmwareAppError
+from . import BaseVmwareApplication
+from . import VmwareAppError
 from .. import __version__ as GLOBAL_VERSION
-# from ..ds_cluster import VsphereDsCluster
 from ..ds_cluster import VsphereDsClusterDict
 from ..errors import VSphereExpectedError
 from ..xlate import XLATOR
 
-__version__ = '1.1.0'
+__version__ = "1.3.1"
 LOG = logging.getLogger(__name__)
 
 _ = XLATOR.gettext
 ngettext = XLATOR.ngettext
 
+
 # =============================================================================
 class GetVmStorageClustersAppError(VmwareAppError):
     """Base exception class for all exceptions in this application."""
@@ -48,18 +51,33 @@ class GetStorageClusterListApp(BaseVmwareApplication):
     """Class for the application object."""
 
     avail_sort_keys = (
-        'cluster_name', 'vsphere_name', 'capacity', 'free_space', 'usage', 'usage_pc')
-    default_sort_keys = ['vsphere_name', 'cluster_name']
+        "cluster_name",
+        "vsphere_name",
+        "capacity",
+        "free_space",
+        "usage",
+        "usage_pc",
+    )
+    default_sort_keys = ["vsphere_name", "cluster_name"]
 
     # -------------------------------------------------------------------------
     def __init__(
-        self, appname=None, verbose=0, version=GLOBAL_VERSION, base_dir=None,
-            initialized=False, usage=None, description=None,
-            argparse_epilog=None, argparse_prefix_chars='-', env_prefix=None):
+        self,
+        appname=None,
+        verbose=0,
+        version=GLOBAL_VERSION,
+        base_dir=None,
+        initialized=False,
+        usage=None,
+        description=None,
+        argparse_epilog=None,
+        argparse_prefix_chars="-",
+        env_prefix=None,
+    ):
         """Initialize a GetStorageClusterListApp object."""
         desc = _(
-            'Tries to get a list of all datastore clusters in '
-            'VMWare VSphere and print it out.')
+            "Tries to get a list of all datastore clusters in " "VMware vSphere and print it out."
+        )
 
         self.st_clusters = []
         self._print_total = True
@@ -67,8 +85,12 @@ class GetStorageClusterListApp(BaseVmwareApplication):
         self.sort_keys = self.default_sort_keys
 
         super(GetStorageClusterListApp, self).__init__(
-            appname=appname, verbose=verbose, version=version, base_dir=base_dir,
-            description=desc, initialized=False,
+            appname=appname,
+            verbose=verbose,
+            version=version,
+            base_dir=base_dir,
+            description=desc,
+            initialized=False,
         )
 
         self.initialized = True
@@ -91,7 +113,7 @@ class GetStorageClusterListApp(BaseVmwareApplication):
         @rtype:  dict
         """
         res = super(GetStorageClusterListApp, self).as_dict(short=short)
-        res['print_total'] = self.print_total
+        res["print_total"] = self.print_total
 
         return res
 
@@ -100,20 +122,30 @@ class GetStorageClusterListApp(BaseVmwareApplication):
         """Public available method to initiate the argument parser."""
         super(GetStorageClusterListApp, self).init_arg_parser()
 
-        output_options = self.arg_parser.add_argument_group(_('Output options'))
+        output_options = self.arg_parser.add_argument_group(_("Output options"))
 
         output_options.add_argument(
-            '-N', '--no-totals', action='store_true', dest='no_totals',
+            "-N",
+            "--no-totals",
+            action="store_true",
+            dest="no_totals",
             help=_("Don't print the totals of all storage clusters."),
         )
 
         output_options.add_argument(
-            '-S', '--sort', metavar='KEY', nargs='+', dest='sort_keys',
-            choices=self.avail_sort_keys, help=_(
-                'The keys for sorting the output. Available keys are: {avail}. '
-                'The default sorting keys are: {default}.').format(
+            "-S",
+            "--sort",
+            metavar="KEY",
+            nargs="+",
+            dest="sort_keys",
+            choices=self.avail_sort_keys,
+            help=_(
+                "The keys for sorting the output. Available keys are: {avail}. "
+                "The default sorting keys are: {default}."
+            ).format(
                 avail=format_list(self.avail_sort_keys, do_repr=True),
-                default=format_list(self.default_sort_keys, do_repr=True))
+                default=format_list(self.default_sort_keys, do_repr=True),
+            ),
         )
 
     # -------------------------------------------------------------------------
@@ -124,14 +156,13 @@ class GetStorageClusterListApp(BaseVmwareApplication):
         if self.args.sort_keys:
             self.sort_keys = self.args.sort_keys
 
-        if getattr(self.args, 'no_totals', False):
+        if getattr(self.args, "no_totals", False):
             self._print_total = False
 
     # -------------------------------------------------------------------------
     def _run(self):
 
-        LOG.debug(_('Starting {a!r}, version {v!r} ...').format(
-            a=self.appname, v=self.version))
+        LOG.debug(_("Starting {a!r}, version {v!r} ...").format(a=self.appname, v=self.version))
 
         ret = 0
         try:
@@ -143,7 +174,7 @@ class GetStorageClusterListApp(BaseVmwareApplication):
 
     # -------------------------------------------------------------------------
     def get_datastore_clusters(self, vsphere_name):
-        """Get all datastore clusters in a VMWare VSPhere."""
+        """Get all datastore clusters in a VMware vSphere."""
         storage_clusters = []
 
         vsphere = self.vsphere[vsphere_name]
@@ -177,16 +208,16 @@ class GetStorageClusterListApp(BaseVmwareApplication):
             _get_all_storage_clusters()
 
         else:
-            spin_prompt = _('Getting all VSPhere storage clusters ...')
+            spin_prompt = _("Getting all vSphere storage clusters ...")
             spinner_name = self.get_random_spinner_name()
             with Spinner(spin_prompt, spinner_name):
                 _get_all_storage_clusters()
-            sys.stdout.write(' ' * len(spin_prompt))
-            sys.stdout.write('\r')
+            sys.stdout.write(" " * len(spin_prompt))
+            sys.stdout.write("\r")
             sys.stdout.flush()
 
         if self.verbose > 2:
-            LOG.debug(_('Found datastore clusters:') + '\n' + pp(all_storage_clusters))
+            LOG.debug(_("Found datastore clusters:") + "\n" + pp(all_storage_clusters))
 
         self.print_clusters(all_storage_clusters)
 
@@ -205,52 +236,54 @@ class GetStorageClusterListApp(BaseVmwareApplication):
 
                 cl = clusters[vsphere_name][cluster_name]
                 cluster = {}
-                cluster['is_total'] = False
+                cluster["is_total"] = False
 
-                cluster['cluster_name'] = cluster_name
+                cluster["cluster_name"] = cluster_name
 
-                cluster['vsphere_name'] = vsphere_name
+                cluster["vsphere_name"] = vsphere_name
+                cluster["dc"] = cl.dc_name
 
-                cluster['capacity'] = cl.capacity_gb
-                cluster['capacity_gb'] = format_decimal(cl.capacity_gb, format='#,##0')
+                cluster["capacity"] = cl.capacity_gb
+                cluster["capacity_gb"] = format_decimal(cl.capacity_gb, format="#,##0")
                 total_capacity += cl.capacity_gb
 
-                cluster['free_space'] = cl.free_space_gb
-                cluster['free_space_gb'] = format_decimal(cl.free_space_gb, format='#,##0')
+                cluster["free_space"] = cl.free_space_gb
+                cluster["free_space_gb"] = format_decimal(cl.free_space_gb, format="#,##0")
                 total_free += cl.free_space_gb
 
                 used = cl.capacity_gb - cl.free_space_gb
-                cluster['usage'] = used
-                cluster['usage_gb'] = format_decimal(used, format='#,##0')
+                cluster["usage"] = used
+                cluster["usage_gb"] = format_decimal(used, format="#,##0")
 
                 if cl.capacity_gb:
                     usage_pc = used / cl.capacity_gb
-                    cluster['usage_pc'] = usage_pc
-                    cluster['usage_pc_out'] = format_decimal(usage_pc, format='0.0 %')
+                    cluster["usage_pc"] = usage_pc
+                    cluster["usage_pc_out"] = format_decimal(usage_pc, format="0.0 %")
                 else:
-                    cluster['usage_pc_out'] = '- %'
+                    cluster["usage_pc_out"] = "- %"
 
                 cluster_list.append(cluster)
 
         if self.print_total:
             total_used = total_capacity - total_free
             total_used_pc = None
-            total_used_pc_out = '- %'
+            total_used_pc_out = "- %"
             if total_capacity:
                 total_used_pc = total_used / total_capacity
-                total_used_pc_out = format_decimal(total_used_pc, format='0.0 %')
+                total_used_pc_out = format_decimal(total_used_pc, format="0.0 %")
 
             self.totals = {
-                'cluster_name': _('Total'),
-                'vsphere_name': '',
-                'is_total': True,
-                'capacity_gb': format_decimal(total_capacity, format='#,##0'),
-                'free_space_gb': format_decimal(total_free, format='#,##0'),
-                'usage_gb': format_decimal(total_used, format='#,##0'),
-                'usage_pc_out': total_used_pc_out,
+                "cluster_name": _("Total"),
+                "vsphere_name": "",
+                "dc": "",
+                "is_total": True,
+                "capacity_gb": format_decimal(total_capacity, format="#,##0"),
+                "free_space_gb": format_decimal(total_free, format="#,##0"),
+                "usage_gb": format_decimal(total_used, format="#,##0"),
+                "usage_pc_out": total_used_pc_out,
             }
             if not self.quiet:
-                self.totals['cluster_name'] += ':'
+                self.totals["cluster_name"] += ":"
 
         return cluster_list
 
@@ -280,17 +313,24 @@ class GetStorageClusterListApp(BaseVmwareApplication):
     def print_clusters(self, clusters):
         """Print on STDOUT all information about all datastore clusters."""
         labels = {
-            'cluster_name': 'Cluster',
-            'vsphere_name': 'VSPhere',
-            'capacity_gb': _('Capacity in GB'),
-            'free_space_gb': _('Free space in GB'),
-            'usage_gb': _('Calculated usage in GB'),
-            'usage_pc_out': _('Usage in percent'),
+            "cluster_name": "Cluster",
+            "vsphere_name": "vSphere",
+            "dc": _("Data Center"),
+            "capacity_gb": _("Capacity in GB"),
+            "free_space_gb": _("Free space in GB"),
+            "usage_gb": _("Calculated usage in GB"),
+            "usage_pc_out": _("Usage in percent"),
         }
 
         label_list = (
-            'cluster_name', 'vsphere_name', 'capacity_gb',
-            'usage_gb', 'usage_pc_out', 'free_space_gb')
+            "cluster_name",
+            "vsphere_name",
+            "dc",
+            "capacity_gb",
+            "usage_gb",
+            "usage_pc_out",
+            "free_space_gb",
+        )
 
         cluster_list = self._get_cluster_list(clusters)
         field_length = self._get_cluster_fields_len(cluster_list, labels)
@@ -304,26 +344,26 @@ class GetStorageClusterListApp(BaseVmwareApplication):
             max_len += field_length[label]
 
         if self.verbose > 2:
-            LOG.debug('Label length:\n' + pp(field_length))
-            LOG.debug('Max line length: {} chars'.format(max_len))
-            LOG.debug('Datastore clusters:\n' + pp(cluster_list))
+            LOG.debug("Label length:\n" + pp(field_length))
+            LOG.debug("Max line length: {} chars".format(max_len))
+            LOG.debug("Datastore clusters:\n" + pp(cluster_list))
 
-        tpl = ''
+        tpl = ""
         for label in label_list:
-            if tpl != '':
-                tpl += '  '
-            if label in ('cluster_name', 'vsphere_name'):
-                tpl += '{{{la}:<{le}}}'.format(la=label, le=field_length[label])
+            if tpl != "":
+                tpl += "  "
+            if label in ("cluster_name", "vsphere_name", "dc"):
+                tpl += "{{{la}:<{le}}}".format(la=label, le=field_length[label])
             else:
-                tpl += '{{{la}:>{le}}}'.format(la=label, le=field_length[label])
+                tpl += "{{{la}:>{le}}}".format(la=label, le=field_length[label])
         if self.verbose > 1:
-            LOG.debug(_('Line template: {}').format(tpl))
+            LOG.debug(_("Line template: {}").format(tpl))
 
         if self.sort_keys:
-            LOG.debug('Sorting keys: ' + pp(self.sort_keys))
+            LOG.debug("Sorting keys: " + pp(self.sort_keys))
             self.sort_keys.reverse()
             for key in self.sort_keys:
-                if key in ('cluster_name', 'vsphere_name'):
+                if key in ("cluster_name", "vsphere_name"):
                     cluster_list.sort(key=itemgetter(key))
                 else:
                     cluster_list.sort(key=itemgetter(key), reverse=True)
@@ -331,32 +371,52 @@ class GetStorageClusterListApp(BaseVmwareApplication):
         if not self.quiet:
             print()
             print(tpl.format(**labels))
-            print('-' * max_len)
+            print("-" * max_len)
 
         for cluster in cluster_list:
             print(tpl.format(**cluster))
 
         if self.totals:
             if not self.quiet:
-                print('-' * max_len)
+                print("-" * max_len)
             print(tpl.format(**self.totals))
 
         if not self.quiet:
             print()
             if count:
                 msg = ngettext(
-                    'Found one VMWare storage cluster.',
-                    'Found {} VMWare storage clusters.'.format(count),
-                    count)
+                    "Found one VMware storage cluster.",
+                    "Found {} VMware storage clusters.",
+                    count,
+                ).format(count)
             else:
-                msg = _('No VMWare storage clusters found.')
+                msg = _("No VMware storage clusters found.")
 
             print(msg)
             print()
 
 
 # =============================================================================
-if __name__ == '__main__':
+def main():
+    """Entrypoint for get-vsphere-storage-cluster-list."""
+    my_path = pathlib.Path(__file__)
+    appname = my_path.name
+
+    locale.setlocale(locale.LC_ALL, "")
+
+    app = GetStorageClusterListApp(appname=appname)
+    app.initialized = True
+
+    if app.verbose > 2:
+        print(_("{c}-Object:\n{a}").format(c=app.__class__.__name__, a=app), file=sys.stderr)
+
+    app()
+
+    sys.exit(0)
+
+
+# =============================================================================
+if __name__ == "__main__":
 
     pass