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

fb_vmware/app/get_vm_list.py

@@ -10,7 +10,9 @@
 from __future__ import absolute_import, print_function
 
 # Standard modules
+import locale
 import logging
+import pathlib
 import re
 import sys
 from operator import attrgetter, itemgetter
@@ -28,7 +30,7 @@ from ..errors import VSphereExpectedError
 from ..vm import VsphereVm
 from ..xlate import XLATOR
 
-__version__ = '1.7.0'
+__version__ = "1.9.0"
 LOG = logging.getLogger(__name__)
 
 _ = XLATOR.gettext
@@ -46,19 +48,38 @@ class GetVmListAppError(VmwareAppError):
 class GetVmListApplication(BaseVmwareApplication):
     """Class for the application objects."""
 
-    default_vm_pattern = r'.*'
-    avail_sort_keys = ('name', 'vsphere', 'cluster', 'path', 'type', 'onl_str', 'cfg_ver', 'os')
-    default_sort_keys = ['name', 'vsphere']
+    default_vm_pattern = r".*"
+    avail_sort_keys = (
+        "name",
+        "vsphere",
+        "dc",
+        "cluster",
+        "path",
+        "type",
+        "onl_str",
+        "cfg_ver",
+        "os",
+    )
+    default_sort_keys = ["name", "vsphere", "dc"]
 
     # -------------------------------------------------------------------------
     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 GetVmListApplication object."""
         desc = _(
-            'Tries to get a list of all virtual machines in '
-            'VMWare VSphere and print it out.')
+            "Tries to get a list of all virtual machines in " "VMware vSphere and print it out."
+        )
 
         self._vm_pattern = self.default_vm_pattern
         self._details = False
@@ -71,8 +92,12 @@ class GetVmListApplication(BaseVmwareApplication):
         self.vms = []
 
         super(GetVmListApplication, 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
@@ -105,9 +130,9 @@ class GetVmListApplication(BaseVmwareApplication):
         @rtype:  dict
         """
         res = super(GetVmListApplication, self).as_dict(short=short)
-        res['details'] = self.details
-        res['vm_pattern'] = self.vm_pattern
-        res['default_vm_pattern'] = self.default_vm_pattern
+        res["details"] = self.details
+        res["vm_pattern"] = self.vm_pattern
+        res["default_vm_pattern"] = self.default_vm_pattern
 
         return res
 
@@ -128,66 +153,105 @@ class GetVmListApplication(BaseVmwareApplication):
         """Initiate the argument parser."""
         super(GetVmListApplication, self).init_arg_parser()
 
-        filter_group = self.arg_parser.add_argument_group(_('Filter options'))
+        filter_group = self.arg_parser.add_argument_group(_("Filter options"))
 
         filter_group.add_argument(
-            '-p', '--pattern', '--search-pattern',
-            dest='vm_pattern', metavar='REGEX', action=RegexOptionAction,
-            topic=_('for names of VMs'), re_options=re.IGNORECASE,
+            "-p",
+            "--pattern",
+            "--search-pattern",
+            dest="vm_pattern",
+            metavar="REGEX",
+            action=RegexOptionAction,
+            topic=_("for names of VMs"),
+            re_options=re.IGNORECASE,
             help=_(
-                'A regular expression to filter the output list of VMs by their name '
-                '(Default: {!r}).').format(self.default_vm_pattern)
+                "A regular expression to filter the output list of VMs by their name "
+                "(Default: {!r})."
+            ).format(self.default_vm_pattern),
         )
 
-        valid_vm_types = ('all', 'vm', 'template')
+        valid_vm_types = ("all", "vm", "template")
         filter_group.add_argument(
-            '-T', '--type', metavar=_('TYPE'), dest='vm_type', choices=valid_vm_types,
-            default='all', help=_(
-                'Filter output for the type of the VM. Valid values are {li} '
-                '(Default: {dflt!r}).').format(
-                dflt='all', li=format_list(valid_vm_types, do_repr=True))
+            "-T",
+            "--type",
+            metavar=_("TYPE"),
+            dest="vm_type",
+            choices=valid_vm_types,
+            default="all",
+            help=_(
+                "Filter output for the type of the VM. Valid values are {li} "
+                "(Default: {dflt!r})."
+            ).format(dflt="all", li=format_list(valid_vm_types, do_repr=True)),
         )
 
         online_filter = filter_group.add_mutually_exclusive_group()
         online_filter.add_argument(
-            '--on', '--online', action='store_true', dest='online',
-            help=_('Filter output for online VMs.')
+            "--on",
+            "--online",
+            action="store_true",
+            dest="online",
+            help=_("Filter output for online VMs."),
         )
         online_filter.add_argument(
-            '--off', '--offline', action='store_true', dest='offline',
-            help=_('Filter output for offline VMs and templates.')
+            "--off",
+            "--offline",
+            action="store_true",
+            dest="offline",
+            help=_("Filter output for offline VMs and templates."),
         )
 
         filter_group.add_argument(
-            '-H', '--hw', '--hardware-config', metavar='REGEX', action=RegexOptionAction,
-            dest='hw', topic=_('for VMWare hardware config version'), re_options=re.IGNORECASE,
+            "-H",
+            "--hw",
+            "--hardware-config",
+            metavar="REGEX",
+            action=RegexOptionAction,
+            dest="hw",
+            topic=_("for VMware hardware config version"),
+            re_options=re.IGNORECASE,
             help=_(
-                'A regular expression to filter the output list of VMs by the VMWare hardware '
-                "configuration version (e.g. '{}').").format(r'vmx-0\d$'),
+                "A regular expression to filter the output list of VMs by the VMware hardware "
+                "configuration version (e.g. '{}')."
+            ).format(r"vmx-0\d$"),
         )
 
         filter_group.add_argument(
-            '--os', metavar='REGEX', action=RegexOptionAction, dest='os',
-            topic=_('for the Operating System version'), re_options=re.IGNORECASE,
+            "--os",
+            metavar="REGEX",
+            action=RegexOptionAction,
+            dest="os",
+            topic=_("for the Operating System version"),
+            re_options=re.IGNORECASE,
             help=_(
-                'A regular expression to filter the output list of VMs by their Operating '
-                "System version, e.g. '{}'.").format('oracleLinux.*(_64)?Guest')
+                "A regular expression to filter the output list of VMs by their Operating "
+                "System version, e.g. '{}'."
+            ).format("oracleLinux.*(_64)?Guest"),
         )
 
-        output_options = self.arg_parser.add_argument_group(_('Output options'))
+        output_options = self.arg_parser.add_argument_group(_("Output options"))
 
         output_options.add_argument(
-            '-D', '--details', dest='details', action='store_true',
-            help=_('Detailed output list (quering data needs some time longer).')
+            "-D",
+            "--details",
+            dest="details",
+            action="store_true",
+            help=_("Detailed output list (quering data needs some time longer)."),
         )
 
         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),
+            ),
         )
 
     # -------------------------------------------------------------------------
@@ -201,17 +265,23 @@ class GetVmListApplication(BaseVmwareApplication):
         if self.args.vm_pattern:
             try:
                 re_name = re.compile(self.args.vm_pattern, re.IGNORECASE)
-                LOG.debug(_('Regular expression for filtering: {!r}').format(re_name.pattern))
+                LOG.debug(_("Regular expression for filtering: {!r}").format(re_name.pattern))
                 self._vm_pattern = self.args.vm_pattern
             except Exception as e:
-                msg = _('Got a {c} for pattern {p!r}: {e}').format(
-                    c=e.__class__.__name__, p=self.args.vm_pattern, e=e)
+                msg = _("Got a {c} for pattern {p!r}: {e}").format(
+                    c=e.__class__.__name__, p=self.args.vm_pattern, e=e
+                )
                 LOG.error(msg)
 
         if not self.details:
-            if self.args.online or self.args.offline or self.args.hw or self.args.os or \
-                    self.args.vm_type != 'all':
-                LOG.info(_('Detailed output is required because of your given options.'))
+            if (
+                self.args.online
+                or self.args.offline
+                or self.args.hw
+                or self.args.os
+                or self.args.vm_type != "all"
+            ):
+                LOG.info(_("Detailed output is required because of your given options."))
                 self.details = True
 
         if self.args.sort_keys:
@@ -220,16 +290,20 @@ class GetVmListApplication(BaseVmwareApplication):
             else:
                 self.sort_keys = []
                 for key in self.args.sort_keys:
-                    if key in ('name', 'vsphere', 'path'):
+                    if key in ("name", "vsphere", "path"):
                         self.sort_keys.append(key)
                     else:
-                        LOG.warn(_(
-                            'Sorting key {!r} not usable, if not detailed output '
-                            'was given.').format(key))
+                        LOG.warn(
+                            _(
+                                "Sorting key {!r} not usable, if not detailed output " "was given."
+                            ).format(key)
+                        )
                 if not self.sort_keys:
-                    LOG.warn(_(
-                        'No usable sorting keys found, using default sorting keys {}.').format(
-                        format_list(self.default_sort_keys, do_repr=True)))
+                    LOG.warn(
+                        _("No usable sorting keys found, using default sorting keys {}.").format(
+                            format_list(self.default_sort_keys, do_repr=True)
+                        )
+                    )
                     self.sort_keys = self.default_sort_keys
 
         if self.args.hw:
@@ -240,8 +314,7 @@ class GetVmListApplication(BaseVmwareApplication):
     # -------------------------------------------------------------------------
     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:
@@ -256,7 +329,7 @@ class GetVmListApplication(BaseVmwareApplication):
 
     # -------------------------------------------------------------------------
     def get_all_vms(self):
-        """Get all VMs from VSphere, maybe filtered."""
+        """Get all VMs from vSphere, maybe filtered."""
         ret = 0
         all_vms = []
 
@@ -266,17 +339,17 @@ class GetVmListApplication(BaseVmwareApplication):
             for vsphere_name in self.vsphere:
                 all_vms += self.get_vms(vsphere_name, re_name)
         elif not self.quiet:
-            spin_prompt = _('Getting all VSPhere VMs ...') + ' '
+            spin_prompt = _("Getting all vSphere VMs ...") + " "
             spinner_name = self.get_random_spinner_name()
             with Spinner(spin_prompt, spinner_name):
                 for vsphere_name in self.vsphere:
                     all_vms += self.get_vms(vsphere_name, re_name)
-            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 > 1:
-            LOG.debug(_('Using sorting keys:') + ' ' + format_list(self.sort_keys, do_repr=True))
+            LOG.debug(_("Using sorting keys:") + " " + format_list(self.sort_keys, do_repr=True))
 
         if self.details:
             self.print_vms_detailed(all_vms)
@@ -288,11 +361,12 @@ class GetVmListApplication(BaseVmwareApplication):
     # -------------------------------------------------------------------------
     def print_vms(self, all_vms):
         """Print out on STDOUT the list of found VMs."""
-        label_list = ('name', 'vsphere', 'path')
+        label_list = ("name", "vsphere", "dc", "path")
         labels = {
-            'name': 'Host',
-            'vsphere': 'VSphere',
-            'path': 'Path',
+            "name": _("Host"),
+            "vsphere": "vSphere",
+            "dc": _("Data Center"),
+            "path": _("Path"),
         }
 
         self._print_vms(all_vms, label_list, labels)
@@ -302,14 +376,15 @@ class GetVmListApplication(BaseVmwareApplication):
         """Print out on STDOUT the list of found VMs in a detailled way."""
         label_list = self.avail_sort_keys
         labels = {
-            'name': 'VM/Template',
-            'vsphere': 'VSphere',
-            'cluster': 'Cluster',
-            'path': 'Path',
-            'type': 'Type',
-            'onl_str': 'Online Status',
-            'cfg_ver': 'Config Version',
-            'os': 'Operating System',
+            "name": "VM/Template",
+            "vsphere": "vSphere",
+            "dc": _("Data Center"),
+            "cluster": _("Cluster"),
+            "path": _("Path"),
+            "type": _("Type"),
+            "onl_str": _("Online Status"),
+            "cfg_ver": _("Config Version"),
+            "os": _("Operating System"),
         }
 
         self._print_vms(all_vms, label_list, labels)
@@ -324,9 +399,9 @@ class GetVmListApplication(BaseVmwareApplication):
         max_len = 0
         count = 0
         for cdata in all_vms:
-            for field in ('cluster', 'path', 'type', 'cfg_ver', 'os'):
+            for field in ("cluster", "path", "type", "cfg_ver", "os"):
                 if field in labels and cdata[field] is None:
-                    cdata[field] = '-'
+                    cdata[field] = "~"
             for label in labels.keys():
                 val = cdata[label]
                 if len(val) > str_lengths[label]:
@@ -338,21 +413,21 @@ class GetVmListApplication(BaseVmwareApplication):
             max_len += str_lengths[label]
 
         if self.verbose > 1:
-            LOG.debug('Label length:\n' + pp(str_lengths))
-            LOG.debug('Max line length: {} chars'.format(max_len))
+            LOG.debug("Label length:\n" + pp(str_lengths))
+            LOG.debug("Max line length: {} chars".format(max_len))
 
-        tpl = ''
+        tpl = ""
         for label in label_list:
-            if tpl != '':
-                tpl += '  '
-            tpl += '{{{la}:<{le}}}'.format(la=label, le=str_lengths[label])
+            if tpl != "":
+                tpl += "  "
+            tpl += "{{{la}:<{le}}}".format(la=label, le=str_lengths[label])
         if self.verbose > 1:
-            LOG.debug(_('Line template: {}').format(tpl))
+            LOG.debug(_("Line template: {}").format(tpl))
 
         if not self.quiet:
             print()
             print(tpl.format(**labels))
-            print('-' * max_len)
+            print("-" * max_len)
 
         all_vms.sort(key=itemgetter(*self.sort_keys))
 
@@ -364,17 +439,15 @@ class GetVmListApplication(BaseVmwareApplication):
         if not self.quiet:
             print()
             if count == 0:
-                msg = _('Found no VMWare VMs.')
+                msg = _("Found no VMware VMs.")
             else:
-                msg = ngettext(
-                    'Found one VMWare VM.',
-                    'Found {} VMWare VMs.', count).format(count)
+                msg = ngettext("Found one VMware VM.", "Found {} VMware VMs.", count).format(count)
             print(msg)
             print()
 
     # -------------------------------------------------------------------------
     def get_vms(self, vsphere_name, re_name=None):
-        """Get the filtered list of VMs from VSPhere."""
+        """Get the filtered list of VMs from vSphere."""
         vsphere = self.vsphere[vsphere_name]
         vsphere.get_datacenter()
 
@@ -394,7 +467,7 @@ class GetVmListApplication(BaseVmwareApplication):
     def mangle_vmlist_no_details(self, vm_list, vsphere_name):
         """Prepare the non-detailled data about found VMs for output."""
         if self.verbose > 3:
-            LOG.debug('Mangling VM list:\n' + pp(vm_list))
+            LOG.debug("Mangling VM list:\n" + pp(vm_list))
 
         vms = []
         first = True
@@ -402,21 +475,22 @@ class GetVmListApplication(BaseVmwareApplication):
         for vm in sorted(vm_list, key=itemgetter(0, 1)):
 
             if self.verbose > 2 and first:
-                LOG.debug('VM:\n' + pp(vm))
+                LOG.debug("VM:\n" + pp(vm))
 
             cdata = {
-                'vsphere': vsphere_name,
-                'name': vm[0],
-                'path': vm[1],
+                "vsphere": vsphere_name,
+                "name": vm[0],
+                "dc": vm[1],
+                "path": vm[2],
             }
 
-            if cdata['path']:
-                cdata['path'] = '/' + cdata['path']
+            if cdata["path"]:
+                cdata["path"] = "/" + cdata["path"]
             else:
-                cdata['path'] = '/'
+                cdata["path"] = "/"
 
             if self.verbose > 2 and first:
-                LOG.debug('Mangled VM:\n' + pp(cdata))
+                LOG.debug("Mangled VM:\n" + pp(cdata))
 
             first = False
 
@@ -430,20 +504,20 @@ class GetVmListApplication(BaseVmwareApplication):
         vms = []
 
         first = True
-        for vm in sorted(vm_list, key=attrgetter('name', 'path')):
+        for vm in sorted(vm_list, key=attrgetter("name", "path")):
 
             if not isinstance(vm, VsphereVm):
-                msg = _('Found a {} object:').format(vm.__class__.__name__)
-                msg += '\n' + pp(vm)
+                msg = _("Found a {} object:").format(vm.__class__.__name__)
+                msg += "\n" + pp(vm)
                 LOG.error(msg)
                 continue
 
             if self.verbose > 2 and first:
-                LOG.debug('VM:\n' + pp(vm.as_dict()))
+                LOG.debug("VM:\n" + pp(vm.as_dict()))
 
             cdata = self._mangle_vm_details(vm, vsphere_name)
             if self.verbose > 2 and first and cdata:
-                LOG.debug('Mangled VM:\n' + pp(cdata))
+                LOG.debug("Mangled VM:\n" + pp(cdata))
 
             first = False
 
@@ -459,8 +533,8 @@ class GetVmListApplication(BaseVmwareApplication):
 
         cdata = None
 
-        if self.args.vm_type != 'all':
-            if self.args.vm_type == 'vm':
+        if self.args.vm_type != "all":
+            if self.args.vm_type == "vm":
                 if vm.template:
                     return None
             else:
@@ -482,40 +556,64 @@ class GetVmListApplication(BaseVmwareApplication):
             if not self._re_os.search(vm.config_version):
                 return None
 
+        dc = "~"
+        if vm.dc_name:
+            dc = vm.dc_name
+
         cdata = {
-            'vsphere': vsphere_name,
-            'cluster': vm.cluster_name,
-            'name': vm.name,
-            'path': vm.path,
-            'type': 'Virtual Machine',
-            'online': vm.online,
-            'onl_str': 'Online',
-            'cfg_ver': vm.config_version,
-            'os': vm.guest_id,
+            "vsphere": vsphere_name,
+            "dc": dc,
+            "cluster": vm.cluster_name,
+            "name": vm.name,
+            "path": vm.path,
+            "type": "Virtual Machine",
+            "online": vm.online,
+            "onl_str": "Online",
+            "cfg_ver": vm.config_version,
+            "os": vm.guest_id,
         }
 
-        if cdata['path']:
-            cdata['path'] = '/' + cdata['path']
+        if cdata["path"]:
+            cdata["path"] = "/" + cdata["path"]
         else:
-            cdata['path'] = '/'
+            cdata["path"] = "/"
 
-        if not cdata['cluster']:
-            cdata['cluster'] = None
+        if not cdata["cluster"]:
+            cdata["cluster"] = None
 
-        if not cdata['os']:
-            cdata['os'] = None
+        if not cdata["os"]:
+            cdata["os"] = None
 
         if not vm.online:
-            cdata['onl_str'] = 'Offline'
+            cdata["onl_str"] = "Offline"
 
         if vm.template:
-            cdata['type'] = 'VMWare Template'
+            cdata["type"] = "VMware Template"
 
         return cdata
 
 
 # =============================================================================
-if __name__ == '__main__':
+def main():
+    """Entrypoint for get-vsphere-vm-list."""
+    my_path = pathlib.Path(__file__)
+    appname = my_path.name
+
+    locale.setlocale(locale.LC_ALL, "")
+
+    app = GetVmListApplication(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