fb-vmware 1.5.1__py3-none-any.whl → 1.6.0__py3-none-any.whl

fb_vmware/__init__.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 """
-@summary: The module for a base VSphere handler object.
+@summary: The module for a base vSphere handler object.
 
 @author: Frank Brehm
 @contact: frank@brehm-online.com
@@ -56,7 +56,7 @@ from .vm import VsphereVmList
 from .xlate import XLATOR
 
 
-__version__ = '1.5.1'
+__version__ = "1.6.0"
 
 LOG = logging.getLogger(__name__)
 
@@ -65,7 +65,7 @@ _ = XLATOR.gettext
 
 # =============================================================================
 
-if __name__ == '__main__':
+if __name__ == "__main__":
 
     pass
 

fb_vmware/about.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 """
-@summary: The module for capsulating a VSphere about info object.
+@summary: The module for capsulating a vSphere about info object.
 
 @author: Frank Brehm
 @contact: frank@brehm-online.com
@@ -24,7 +24,7 @@ from pyVmomi import vim
 # Own modules
 from .xlate import XLATOR
 
-__version__ = '1.0.1'
+__version__ = "1.0.1"
 LOG = logging.getLogger(__name__)
 
 _ = XLATOR.gettext
@@ -32,11 +32,12 @@ _ = XLATOR.gettext
 
 # =============================================================================
 class VsphereAboutInfo(FbBaseObject):
-    """This is a wrapper for the about-information of a VMWare-VSphere center."""
+    """This is a wrapper for the about-information of a VMware vSphere center."""
 
     # -------------------------------------------------------------------------
     def __init__(
-            self, appname=None, verbose=0, version=__version__, base_dir=None, initialized=None):
+        self, appname=None, verbose=0, version=__version__, base_dir=None, initialized=None
+    ):
         """Initialize the VsphereAboutInfo object."""
         self._api_type = None
         self._api_version = None
@@ -50,7 +51,8 @@ class VsphereAboutInfo(FbBaseObject):
         self._lic_prodversion = None
 
         super(VsphereAboutInfo, self).__init__(
-            appname=appname, verbose=verbose, version=version, base_dir=base_dir)
+            appname=appname, verbose=verbose, version=version, base_dir=base_dir
+        )
 
         if initialized is not None:
             self.initialized = initialized
@@ -68,7 +70,7 @@ class VsphereAboutInfo(FbBaseObject):
             self._api_type = None
             return
         v = str(value).strip()
-        if v == '':
+        if v == "":
             self._api_type = None
         else:
             self._api_type = v
@@ -86,7 +88,7 @@ class VsphereAboutInfo(FbBaseObject):
             self._api_version = None
             return
         v = str(value).strip()
-        if v == '':
+        if v == "":
             self._api_version = None
         else:
             self._api_version = v
@@ -104,7 +106,7 @@ class VsphereAboutInfo(FbBaseObject):
             self._name = None
             return
         v = str(value).strip()
-        if v == '':
+        if v == "":
             self._name = None
         else:
             self._name = v
@@ -122,7 +124,7 @@ class VsphereAboutInfo(FbBaseObject):
             self._full_name = None
             return
         v = str(value).strip()
-        if v == '':
+        if v == "":
             self._full_name = None
         else:
             self._full_name = v
@@ -140,7 +142,7 @@ class VsphereAboutInfo(FbBaseObject):
             self._vendor = None
             return
         v = str(value).strip()
-        if v == '':
+        if v == "":
             self._vendor = None
         else:
             self._vendor = v
@@ -158,7 +160,7 @@ class VsphereAboutInfo(FbBaseObject):
             self._os_version = None
             return
         v = str(value).strip()
-        if v == '':
+        if v == "":
             self._os_version = None
         else:
             self._os_version = v
@@ -176,7 +178,7 @@ class VsphereAboutInfo(FbBaseObject):
             self._os_type = None
             return
         v = str(value).strip()
-        if v == '':
+        if v == "":
             self._os_type = None
         else:
             self._os_type = v
@@ -194,7 +196,7 @@ class VsphereAboutInfo(FbBaseObject):
             self._instance_uuid = None
             return
         v = str(value).strip()
-        if v == '':
+        if v == "":
             self._instance_uuid = None
         else:
             try:
@@ -216,7 +218,7 @@ class VsphereAboutInfo(FbBaseObject):
             self._lic_prodname = None
             return
         v = str(value).strip()
-        if v == '':
+        if v == "":
             self._lic_prodname = None
         else:
             self._lic_prodname = v
@@ -234,7 +236,7 @@ class VsphereAboutInfo(FbBaseObject):
             self._lic_prodversion = None
             return
         v = str(value).strip()
-        if v == '':
+        if v == "":
             self._lic_prodversion = None
         else:
             self._lic_prodversion = v
@@ -251,16 +253,16 @@ class VsphereAboutInfo(FbBaseObject):
         @rtype:  dict
         """
         res = super(VsphereAboutInfo, self).as_dict(short=short)
-        res['api_type'] = self.api_type
-        res['api_version'] = self.api_version
-        res['name'] = self.name
-        res['full_name'] = self.full_name
-        res['vendor'] = self.vendor
-        res['os_version'] = self.os_version
-        res['os_type'] = self.os_type
-        res['instance_uuid'] = self.instance_uuid
-        res['lic_prodname'] = self.lic_prodname
-        res['lic_prodversion'] = self.lic_prodversion
+        res["api_type"] = self.api_type
+        res["api_version"] = self.api_version
+        res["name"] = self.name
+        res["full_name"] = self.full_name
+        res["vendor"] = self.vendor
+        res["os_version"] = self.os_version
+        res["os_type"] = self.os_type
+        res["instance_uuid"] = self.instance_uuid
+        res["lic_prodname"] = self.lic_prodname
+        res["lic_prodversion"] = self.lic_prodversion
 
         return res
 
@@ -271,8 +273,17 @@ class VsphereAboutInfo(FbBaseObject):
         if test_mode:
 
             necessary_fields = (
-                'apiType', 'apiVersion', 'name', 'fullName', 'vendor', 'version',
-                'osType', 'instanceUuid', 'licenseProductName', 'licenseProductVersion')
+                "apiType",
+                "apiVersion",
+                "name",
+                "fullName",
+                "vendor",
+                "version",
+                "osType",
+                "instanceUuid",
+                "licenseProductName",
+                "licenseProductVersion",
+            )
             failing_fields = []
 
             for field in necessary_fields:
@@ -281,47 +292,47 @@ class VsphereAboutInfo(FbBaseObject):
 
             if len(failing_fields):
                 msg = _(
-                    'The given parameter {p!r} on calling method {m}() has failing '
-                    'attributes').format(p='data', m='from_summary')
-                msg += ': ' + format_list(failing_fields, do_repr=True)
+                    "The given parameter {p!r} on calling method {m}() has failing " "attributes"
+                ).format(p="data", m="from_summary")
+                msg += ": " + format_list(failing_fields, do_repr=True)
                 raise AssertionError(msg)
 
         else:
             if not isinstance(data, vim.AboutInfo):
                 msg = _(
-                    'Parameter {t!r} must be a {e} object, a {v} object was given '
-                    'instead.').format(t='data', e='vim.AboutInfo', v=data.__class__.__qualname__)
+                    "Parameter {t!r} must be a {e} object, a {v} object was given " "instead."
+                ).format(t="data", e="vim.AboutInfo", v=data.__class__.__qualname__)
                 raise TypeError(msg)
 
         params = {
-            'appname': appname,
-            'verbose': verbose,
-            'base_dir': base_dir,
-            'initialized': False,
+            "appname": appname,
+            "verbose": verbose,
+            "base_dir": base_dir,
+            "initialized": False,
         }
 
         if verbose > 2:
-            LOG.debug(_('Creating {} object from:').format(cls.__name__) + '\n' + pp(params))
+            LOG.debug(_("Creating {} object from:").format(cls.__name__) + "\n" + pp(params))
         info = cls(**params)
 
-#        'about': (vim.AboutInfo) {
-#               dynamicType = <unset>,
-#               dynamicProperty = (vmodl.DynamicProperty) [],
-#               name = 'VMware vCenter Server',
-#               fullName = 'VMware vCenter Server 6.5.0 build-8024368',
-#               vendor = 'VMware, Inc.',
-#               version = '6.5.0',
-#               build = '8024368',
-#               localeVersion = 'INTL',
-#               localeBuild = '000',
-#               osType = 'linux-x64',
-#               productLineId = 'vpx',
-#               apiType = 'VirtualCenter',
-#               apiVersion = '6.5',
-#               instanceUuid = 'ea1b28ca-0d17-4292-ab04-189e57ec9629',
-#               licenseProductName = 'VMware VirtualCenter Server',
-#               licenseProductVersion = '6.0'
-#        },
+        #        'about': (vim.AboutInfo) {
+        #               dynamicType = <unset>,
+        #               dynamicProperty = (vmodl.DynamicProperty) [],
+        #               name = 'VMware vCenter Server',
+        #               fullName = 'VMware vCenter Server 6.5.0 build-8024368',
+        #               vendor = 'VMware, Inc.',
+        #               version = '6.5.0',
+        #               build = '8024368',
+        #               localeVersion = 'INTL',
+        #               localeBuild = '000',
+        #               osType = 'linux-x64',
+        #               productLineId = 'vpx',
+        #               apiType = 'VirtualCenter',
+        #               apiVersion = '6.5',
+        #               instanceUuid = 'ea1b28ca-0d17-4292-ab04-189e57ec9629',
+        #               licenseProductName = 'VMware VirtualCenter Server',
+        #               licenseProductVersion = '6.0'
+        #        },
 
         info.api_type = data.apiType
         info.api_version = data.apiVersion
@@ -337,7 +348,7 @@ class VsphereAboutInfo(FbBaseObject):
         info.initialized = True
 
         if verbose > 2:
-            LOG.debug(_('Created {} object:').format(cls.__name__) + '\n' + pp(info.as_dict()))
+            LOG.debug(_("Created {} object:").format(cls.__name__) + "\n" + pp(info.as_dict()))
 
         return info
 
@@ -345,8 +356,8 @@ class VsphereAboutInfo(FbBaseObject):
     def __copy__(self):
         """Return a new VsphereAboutInfo object with data from current object copied in."""
         info = VsphereAboutInfo(
-            appname=self.appname, verbose=self.verbose, base_dir=self.base_dir,
-            initialized=False)
+            appname=self.appname, verbose=self.verbose, base_dir=self.base_dir, initialized=False
+        )
 
         info.api_type = self.api_type
         info.api_version = self.api_version
@@ -365,7 +376,7 @@ class VsphereAboutInfo(FbBaseObject):
 
 
 # =============================================================================
-if __name__ == '__main__':
+if __name__ == "__main__":
 
     pass
 

fb_vmware/app/__init__.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 """
-@summary: A base module for all VMWare/VSPhere application classes.
+@summary: A base module for all VMware/vSphere application classes.
 
 @author: Frank Brehm
 @contact: frank@brehm-online.com
@@ -12,6 +12,8 @@ from __future__ import absolute_import, print_function
 # Standard modules
 import copy
 import logging
+import os
+import pathlib
 import random
 
 # Third party modules
@@ -28,11 +30,17 @@ from .. import __version__ as GLOBAL_VERSION
 from ..config import VmwareConfiguration
 from ..connect import VsphereConnection
 from ..errors import VSphereExpectedError
+from ..xlate import DOMAIN
+from ..xlate import LOCALE_DIR
 from ..xlate import XLATOR
+from ..xlate import __base_dir__ as __xlate_base_dir__
+from ..xlate import __lib_dir__ as __xlate_lib_dir__
+from ..xlate import __mo_file__ as __xlate_mo_file__
+from ..xlate import __module_dir__ as __xlate_module_dir__
 
-__version__ = '1.2.1'
+__version__ = "1.3.0"
 LOG = logging.getLogger(__name__)
-TZ = pytz.timezone('Europe/Berlin')
+TZ = pytz.timezone("Europe/Berlin")
 
 _ = XLATOR.gettext
 ngettext = XLATOR.ngettext
@@ -40,36 +48,60 @@ ngettext = XLATOR.ngettext
 
 # =============================================================================
 class VmwareAppError(FbAppError):
-    """Base exception class for all exceptions in all VMWare/VSPhere application classes."""
+    """Base exception class for all exceptions in all VMware/vSphere application classes."""
 
     pass
 
 
 # =============================================================================
 class BaseVmwareApplication(FbConfigApplication):
-    """Base class for all VMWare/VSPhere application classes."""
+    """Base class for all VMware/vSphere application classes."""
 
     # -------------------------------------------------------------------------
     def __init__(
-        self, appname=None, verbose=0, version=GLOBAL_VERSION, base_dir=None,
-            cfg_class=VmwareConfiguration, initialized=False, usage=None, description=None,
-            argparse_epilog=None, argparse_prefix_chars='-', env_prefix=None,
-            append_appname_to_stems=True, config_dir=None, additional_stems=None,
-            additional_cfgdirs=None, cfg_encoding=DEFAULT_ENCODING,
-            use_chardet=True):
+        self,
+        appname=None,
+        verbose=0,
+        version=GLOBAL_VERSION,
+        base_dir=None,
+        cfg_class=VmwareConfiguration,
+        initialized=False,
+        usage=None,
+        description=None,
+        argparse_epilog=None,
+        argparse_prefix_chars="-",
+        env_prefix=None,
+        append_appname_to_stems=True,
+        config_dir=None,
+        additional_stems=None,
+        additional_cfgdirs=None,
+        cfg_encoding=DEFAULT_ENCODING,
+        use_chardet=True,
+    ):
         """Initialize a BaseVmwareApplication object."""
         self.req_vspheres = None
         self.do_vspheres = []
 
-        # Hash with all VSphere handler objects
+        if base_dir is None:
+            base_dir = pathlib.Path(os.getcwd()).resolve()
+
+        # Hash with all vSphere handler objects
         self.vsphere = {}
 
         super(BaseVmwareApplication, self).__init__(
-            appname=appname, verbose=verbose, version=version, base_dir=base_dir,
-            description=description, cfg_class=cfg_class,
-            append_appname_to_stems=append_appname_to_stems, config_dir=config_dir,
-            additional_stems=additional_stems, additional_cfgdirs=additional_cfgdirs,
-            cfg_encoding=cfg_encoding, use_chardet=use_chardet, initialized=False,
+            appname=appname,
+            verbose=verbose,
+            version=version,
+            base_dir=base_dir,
+            description=description,
+            cfg_class=cfg_class,
+            append_appname_to_stems=append_appname_to_stems,
+            config_dir=config_dir,
+            additional_stems=additional_stems,
+            additional_cfgdirs=additional_cfgdirs,
+            cfg_encoding=cfg_encoding,
+            use_chardet=use_chardet,
+            initialized=False,
         )
 
     # -------------------------------------------------------------------------
@@ -78,6 +110,30 @@ class BaseVmwareApplication(FbConfigApplication):
         if self.vsphere.keys():
             self.cleaning_up()
 
+    # -------------------------------------------------------------------------
+    def as_dict(self, short=True):
+        """
+        Transform the elements of the object into a dict.
+
+        @param short: don't include local properties in resulting dict.
+        @type short: bool
+
+        @return: structure as dict
+        @rtype:  dict
+        """
+        res = super(BaseVmwareApplication, self).as_dict(short=short)
+
+        res["xlate"]["fb_vmware"] = {
+            "__module_dir__": __xlate_module_dir__,
+            "__lib_dir__": __xlate_lib_dir__,
+            "__base_dir__": __xlate_base_dir__,
+            "LOCALE_DIR": LOCALE_DIR,
+            "DOMAIN": DOMAIN,
+            "__mo_file__": __xlate_mo_file__,
+        }
+
+        return res
+
     # -------------------------------------------------------------------------
     def post_init(self):
         """
@@ -95,10 +151,10 @@ class BaseVmwareApplication(FbConfigApplication):
         super(BaseVmwareApplication, self).post_init()
 
         if self.verbose > 2:
-            LOG.debug(_('{what} of {app} ...').format(what='post_init()', app=self.appname))
+            LOG.debug(_("{what} of {app} ...").format(what="post_init()", app=self.appname))
 
         if not self.cfg.vsphere.keys():
-            msg = _('Did not found any configured Vsphere environments.')
+            msg = _("Did not found any configured vSphere environments.")
             LOG.error(msg)
             self.exit(3)
 
@@ -106,13 +162,13 @@ class BaseVmwareApplication(FbConfigApplication):
             self.req_vspheres = []
             all_found = True
             for vs_name in self.args.req_vsphere:
-                LOG.debug(_('Checking for configured VSPhere instance {!r} ...').format(vs_name))
+                LOG.debug(_("Checking for configured vSphere instance {!r} ...").format(vs_name))
                 vs = vs_name.strip().lower()
                 if vs not in self.cfg.vsphere.keys():
                     all_found = False
                     msg = _(
-                        'VSPhere {!r} not found in list of configured VSPhere instances.').format(
-                            vs_name)
+                        "vSphere {!r} not found in list of configured vSphere instances."
+                    ).format(vs_name)
                     LOG.error(msg)
                 else:
                     if vs not in self.req_vspheres:
@@ -134,22 +190,24 @@ class BaseVmwareApplication(FbConfigApplication):
         super(BaseVmwareApplication, self).init_arg_parser()
 
         self.arg_parser.add_argument(
-            '--vs', '--vsphere', dest='req_vsphere', nargs='*',
-            help=_(
-                'The VSPhere names from configuration, in which the VMs should be searched.')
+            "--vs",
+            "--vsphere",
+            dest="req_vsphere",
+            nargs="*",
+            help=_("The vSphere names from configuration, in which the VMs should be searched."),
         )
 
     # -------------------------------------------------------------------------
     def perform_arg_parser(self):
         """Evaluate the command line parameters. Maybe overridden."""
         if self.verbose > 2:
-            LOG.debug(_('Got command line arguments:') + '\n' + pp(self.args))
+            LOG.debug(_("Got command line arguments:") + "\n" + pp(self.args))
 
     # -------------------------------------------------------------------------
     def init_vsphere_handlers(self):
-        """Initialize all VSphere handlers."""
+        """Initialize all vSphere handlers."""
         if self.verbose > 1:
-            LOG.debug(_('Initializing VSphere handlers ...'))
+            LOG.debug(_("Initializing vSphere handlers ..."))
 
         try:
             for vsphere_name in self.do_vspheres:
@@ -160,36 +218,43 @@ class BaseVmwareApplication(FbConfigApplication):
 
     # -------------------------------------------------------------------------
     def init_vsphere_handler(self, vsphere_name):
-        """Initialize the given VSphere handler."""
+        """Initialize the given vSphere handler."""
         if self.verbose > 2:
-            LOG.debug(_('Initializing handler for VSPhere {!r} ...').format(vsphere_name))
+            LOG.debug(_("Initializing handler for vSphere {!r} ...").format(vsphere_name))
 
         vsphere_data = self.cfg.vsphere[vsphere_name]
 
         vsphere = VsphereConnection(
-            vsphere_data, auto_close=True, simulate=self.simulate, force=self.force,
-            appname=self.appname, verbose=self.verbose, base_dir=self.base_dir,
-            terminal_has_colors=self.terminal_has_colors, initialized=False)
+            vsphere_data,
+            auto_close=True,
+            simulate=self.simulate,
+            force=self.force,
+            appname=self.appname,
+            verbose=self.verbose,
+            base_dir=self.base_dir,
+            terminal_has_colors=self.terminal_has_colors,
+            initialized=False,
+        )
 
         if vsphere:
             self.vsphere[vsphere_name] = vsphere
             vsphere.initialized = True
         else:
-            msg = _('Could not initialize {} object from:').format('VsphereConnection')
-            msg += '\n' + str(vsphere_data)
+            msg = _("Could not initialize {} object from:").format("VsphereConnection")
+            msg += "\n" + str(vsphere_data)
             LOG.error(msg)
 
         vsphere._check_credentials()
 
     # -------------------------------------------------------------------------
     def cleaning_up(self):
-        """Close all VSPhere connections and remove all VSphere handlers."""
+        """Close all vSphere connections and remove all vSphere handlers."""
         if self.verbose > 1:
-            LOG.debug(_('Cleaning up ...'))
+            LOG.debug(_("Cleaning up ..."))
 
         for vsphere_name in self.do_vspheres:
             if vsphere_name in self.vsphere:
-                LOG.debug(_('Closing VSPhere object {!r} ...').format(vsphere_name))
+                LOG.debug(_("Closing vSphere object {!r} ...").format(vsphere_name))
                 self.vsphere[vsphere_name].disconnect()
                 del self.vsphere[vsphere_name]
 
@@ -203,7 +268,7 @@ class BaseVmwareApplication(FbConfigApplication):
 
 
 # =============================================================================
-if __name__ == '__main__':
+if __name__ == "__main__":
 
     pass