vortex-nwp 2.0.0b1__py3-none-any.whl → 2.1.0__py3-none-any.whl

vortex/tools/addons.py

@@ -23,53 +23,50 @@ class Addon(footprints.FootprintBase):
     """Root class for any :class:`Addon` system subclasses."""
 
     _abstract = True
-    _collector = ('addon',)
+    _collector = ("addon",)
     _footprint = dict(
-        info = 'Default add-on',
-        attr = dict(
-            kind = dict(),
-            sh = dict(
-                type     = OSExtended,
-                alias    = ('shell',),
-                access   = 'rwx-weak',
+        info="Default add-on",
+        attr=dict(
+            kind=dict(),
+            sh=dict(
+                type=OSExtended,
+                alias=("shell",),
+                access="rwx-weak",
             ),
-            env = dict(
-                type     = Environment,
-                optional = True,
-                default  = None,
-                access   = 'rwx',
-                doc_visibility = footprints.doc.visibility.ADVANCED
+            env=dict(
+                type=Environment,
+                optional=True,
+                default=None,
+                access="rwx",
+                doc_visibility=footprints.doc.visibility.ADVANCED,
             ),
-            cfginfo = dict(
-                optional = True,
-                default  = '[kind]',
-                doc_visibility = footprints.doc.visibility.ADVANCED
+            cfginfo=dict(
+                optional=True,
+                default="[kind]",
+                doc_visibility=footprints.doc.visibility.ADVANCED,
             ),
-            cmd = dict(
-                optional = True,
-                default  = None,
-                access   = 'rwx',
+            cmd=dict(
+                optional=True,
+                default=None,
+                access="rwx",
             ),
-            path = dict(
-                optional = True,
-                default  = None,
-                access   = 'rwx',
+            path=dict(
+                optional=True,
+                default=None,
+                access="rwx",
             ),
-            cycle = dict(
-                optional = True,
-                default  = None,
-                access   = 'rwx',
+            cycle=dict(
+                optional=True,
+                default=None,
+                access="rwx",
             ),
-            toolkind = dict(
-                optional = True,
-                default  = None
-            ),
-        )
+            toolkind=dict(optional=True, default=None),
+        ),
     )
 
     def __init__(self, *args, **kw):
         """Abstract Addon initialisation."""
-        logger.debug('Abstract Addon init %s', self.__class__)
+        logger.debug("Abstract Addon init %s", self.__class__)
         super().__init__(*args, **kw)
         self.sh.extend(self)
         self._context_cache = defaultdict(dict)
@@ -81,7 +78,9 @@ class Addon(footprints.FootprintBase):
             self.env[k] = clsenv[k]
         if self.path is None:
             self.path = get_from_config_w_default(
-                section="nwp-tools", key=self.kind, default=None,
+                section="nwp-tools",
+                key=self.kind,
+                default=None,
             )
 
     @classmethod
@@ -103,36 +102,44 @@ class Addon(footprints.FootprintBase):
         if ctxtag not in self._context_cache and self.toolkind is not None:
             ltrack = contexts.current().localtracker
             # NB: 'str' is important because local might be in unicode...
-            candidates = [str(self.sh.path.realpath(local))
-                          for local, entry in ltrack.items()
-                          if (entry.latest_rhdict('get').get('resource', dict()).get('kind', '') ==
-                              self.toolkind)]
+            candidates = [
+                str(self.sh.path.realpath(local))
+                for local, entry in ltrack.items()
+                if (
+                    entry.latest_rhdict("get")
+                    .get("resource", dict())
+                    .get("kind", "")
+                    == self.toolkind
+                )
+            ]
             if candidates:
                 realpath = candidates.pop()
-                self._context_cache[ctxtag] = dict(path=self.sh.path.dirname(realpath),
-                                                   cmd=self.sh.path.basename(realpath))
+                self._context_cache[ctxtag] = dict(
+                    path=self.sh.path.dirname(realpath),
+                    cmd=self.sh.path.basename(realpath),
+                )
         return self._context_cache[ctxtag]
 
     @property
     def actual_path(self):
         """The path that should be used in the current context."""
         infos = self._query_context()
-        ctxpath = infos.get('path', None)
+        ctxpath = infos.get("path", None)
         return self.path if ctxpath is None else ctxpath
 
     @property
     def actual_cmd(self):
         """The cmd that should be used in the current context."""
         infos = self._query_context()
-        ctxcmd = infos.get('cmd', None)
+        ctxcmd = infos.get("cmd", None)
         return self.cmd if ctxcmd is None else ctxcmd
 
     def _spawn_commons(self, cmd, **kw):
         """Internal method setting local environment and calling standard shell spawn."""
 
         # Is there a need for an interpreter ?
-        if 'interpreter' in kw:
-            cmd.insert(0, kw.pop('interpreter'))
+        if "interpreter" in kw:
+            cmd.insert(0, kw.pop("interpreter"))
         else:
             # The first element of the command line needs to be executable
             if cmd[0] not in self._cmd_xperms_cache:
@@ -141,16 +148,15 @@ class Addon(footprints.FootprintBase):
 
         # Overwrite global module env values with specific ones
         with self.sh.env.clone() as localenv:
-
             localenv.verbose(True, self.sh)
             localenv.update(self.env)
 
             # Check if a pipe is requested
-            inpipe = kw.pop('inpipe', False)
+            inpipe = kw.pop("inpipe", False)
 
             # Ask the attached shell to run the addon command
             if inpipe:
-                kw.setdefault('stdout', True)
+                kw.setdefault("stdout", True)
                 rc = self.sh.popen(cmd, **kw)
             else:
                 rc = self.sh.spawn(cmd, **kw)
@@ -163,7 +169,7 @@ class Addon(footprints.FootprintBase):
         # Insert the actual tool command as first argument
         cmd.insert(0, self.actual_cmd)
         if self.actual_path is not None:
-            cmd[0] = self.actual_path + '/' + cmd[0]
+            cmd[0] = self.actual_path + "/" + cmd[0]
 
         return self._spawn_commons(cmd, **kw)
 
@@ -172,7 +178,7 @@ class Addon(footprints.FootprintBase):
 
         # Insert the tool path before the first argument
         if self.actual_path is not None:
-            cmd[0] = self.actual_path + '/' + cmd[0]
+            cmd[0] = self.actual_path + "/" + cmd[0]
 
         return self._spawn_commons(cmd, **kw)
 
@@ -182,26 +188,28 @@ class FtrawEnableAddon(Addon):
 
     _abstract = True
     _footprint = dict(
-        info = 'Default add-on with rawftput support.',
-        attr = dict(
-            rawftshell = dict(
-                info     = "Path to ftserv's concatenation shell",
-                optional = True,
-                default  = None,
-                access   = 'rwx',
-                doc_visibility = footprints.doc.visibility.GURU,
+        info="Default add-on with rawftput support.",
+        attr=dict(
+            rawftshell=dict(
+                info="Path to ftserv's concatenation shell",
+                optional=True,
+                default=None,
+                access="rwx",
+                doc_visibility=footprints.doc.visibility.GURU,
             ),
-        )
+        ),
     )
 
     def __init__(self, *args, **kw):
         """Abstract Addon initialisation."""
-        logger.debug('Abstract Addon init %s', self.__class__)
+        logger.debug("Abstract Addon init %s", self.__class__)
         super().__init__(*args, **kw)
         # If needed, look in the config file for the rawftshell
         if self.rawftshell is None:
             self.rawftshell = get_from_config_w_default(
-                section="rawftshell", key=self.kind, default=None,
+                section="rawftshell",
+                key=self.kind,
+                default=None,
             )
 
 
@@ -213,52 +221,59 @@ class AddonGroup(footprints.FootprintBase):
     """
 
     _abstract = True
-    _collector = ('addon',)
+    _collector = ("addon",)
     _footprint = dict(
-        info = 'Default add-on group',
-        attr = dict(
-            kind = dict(),
-            sh = dict(
-                type     = OSExtended,
-                alias    = ('shell',),
+        info="Default add-on group",
+        attr=dict(
+            kind=dict(),
+            sh=dict(
+                type=OSExtended,
+                alias=("shell",),
             ),
-            env = dict(
-                type     = Environment,
-                optional = True,
-                default  = None,
-                doc_visibility = footprints.doc.visibility.ADVANCED,
+            env=dict(
+                type=Environment,
+                optional=True,
+                default=None,
+                doc_visibility=footprints.doc.visibility.ADVANCED,
             ),
-            cycle = dict(
-                optional = True,
-                default  = None,
+            cycle=dict(
+                optional=True,
+                default=None,
             ),
-            verboseload = dict(
-                optional = True,
-                default  = True,
-                type     = bool,
+            verboseload=dict(
+                optional=True,
+                default=True,
+                type=bool,
             ),
-        )
+        ),
     )
 
     _addonslist = None
 
     def __init__(self, *args, **kw):
         """Abstract Addon initialisation."""
-        logger.debug('Abstract Addon init %s', self.__class__)
+        logger.debug("Abstract Addon init %s", self.__class__)
         super().__init__(*args, **kw)
         self._addons_load()
 
     def _addons_load(self):
         if self._addonslist is None:
-            raise RuntimeError("the _addonslist classe variable must be overriden.")
+            raise RuntimeError(
+                "the _addonslist classe variable must be overriden."
+            )
         self._load_addons_from_list(self._addonslist)
 
     def _load_addons_from_list(self, addons):
         if self.verboseload:
             logger.info("Loading the %s Addons group.", self.kind)
         for addon in addons:
-            _shadd = footprints.proxy.addon(kind=addon, sh=self.sh, env=self.env,
-                                            cycle=self.cycle, verboseload=self.verboseload)
+            _shadd = footprints.proxy.addon(
+                kind=addon,
+                sh=self.sh,
+                env=self.env,
+                cycle=self.cycle,
+                verboseload=self.verboseload,
+            )
             if self.verboseload:
                 logger.info("%s Addon is: %s", addon, repr(_shadd))
 
@@ -270,13 +285,13 @@ def require_external_addon(*addons):
 
     If not, a :class:`RuntimeError` exception will be raised.
     """
+
     @nicedeco
     def r_addon_decorator(method):
-
         def decorated(self, *kargs, **kwargs):
             # Create a cache in self... ugly but efficient !
-            if not hasattr(self, '_require_external_addon_check_cache'):
-                setattr(self, '_require_external_addon_check_cache', set())
+            if not hasattr(self, "_require_external_addon_check_cache"):
+                setattr(self, "_require_external_addon_check_cache", set())
             ko_addons = set()
             loaded_addons = None
             for addon in addons:
@@ -289,9 +304,13 @@ def require_external_addon(*addons):
                 else:
                     ko_addons.add(addon)
             if ko_addons:
-                raise RuntimeError('The following addons are needed to use the {:s} method: {:s}'
-                                   .format(method.__name__, ', '.join(ko_addons)))
+                raise RuntimeError(
+                    "The following addons are needed to use the {:s} method: {:s}".format(
+                        method.__name__, ", ".join(ko_addons)
+                    )
+                )
             return method(self, *kargs, **kwargs)
 
         return decorated
+
     return r_addon_decorator

vortex/tools/arm.py

@@ -7,7 +7,7 @@ from bronx.fancies import loggers
 from vortex.util.config import load_template
 
 #: No automatic export
-__all__ = ['ArmForgeTool']
+__all__ = ["ArmForgeTool"]
 
 logger = loggers.getLogger(__name__)
 
@@ -21,18 +21,20 @@ class ArmForgeTool:
         """
         self._t = ticket
         self._sh = self._t.sh
-        self._config = self._sh.default_target.items('armtools')
-        self._ddtpath = self._sh.env.get('VORTEX_ARM_DDT_PATH', None)
-        self._mappath = self._sh.env.get('VORTEX_ARM_MAP_PATH', None)
-        self._forgedir = self._sh.env.get('VORTEX_ARM_FORGE_DIR',
-                                          self.config.get('forgedir', None))
-        self._forgeversion = self._sh.env.get('VORTEX_ARM_FORGE_VERSION',
-                                              self.config.get('forgeversion', 999999))
+        self._config = self._sh.default_target.items("armtools")
+        self._ddtpath = self._sh.env.get("VORTEX_ARM_DDT_PATH", None)
+        self._mappath = self._sh.env.get("VORTEX_ARM_MAP_PATH", None)
+        self._forgedir = self._sh.env.get(
+            "VORTEX_ARM_FORGE_DIR", self.config.get("forgedir", None)
+        )
+        self._forgeversion = self._sh.env.get(
+            "VORTEX_ARM_FORGE_VERSION", self.config.get("forgeversion", 999999)
+        )
         self._forgeversion = int(self._forgeversion)
         if self._forgedir and self._ddtpath is None:
-            self._ddtpath = self._sh.path.join(self._forgedir, 'bin', 'ddt')
+            self._ddtpath = self._sh.path.join(self._forgedir, "bin", "ddt")
         if self._forgedir and self._mappath is None:
-            self._mappath = self._sh.path.join(self._forgedir, 'bin', 'map')
+            self._mappath = self._sh.path.join(self._forgedir, "bin", "map")
 
     @property
     def config(self):
@@ -43,34 +45,52 @@ class ArmForgeTool:
     def ddtpath(self):
         """The path to the DDT debuger executable."""
         if self._ddtpath is None:
-            raise RuntimeError('DDT requested but the DDT path is not configured.')
+            raise RuntimeError(
+                "DDT requested but the DDT path is not configured."
+            )
         return self._ddtpath
 
     @property
     def mappath(self):
         """The path to the MAP profiler executable."""
         if self._mappath is None:
-            raise RuntimeError('MAP requested but the MAP path is not configured.')
+            raise RuntimeError(
+                "MAP requested but the MAP path is not configured."
+            )
         return self._mappath
 
     def _dump_forge_session(self, sources=(), workdir=None):
         """Create the ARM Forge's session file to list source directories."""
-        targetfile = 'armforge-vortex-session-file.ddt'
+        targetfile = "armforge-vortex-session-file.ddt"
         if workdir:
             targetfile = self._sh.path.join(workdir, targetfile)
-        tpl = load_template(self._t, '@armforge-session-conf.tpl',
-                            encoding='utf-8', version=self._forgeversion)
-        sconf = tpl.substitute(sourcedirs='\n'.join(['        <directory>{:s}</directory>'.format(d)
-                                                     for d in sources]))
-        with open(targetfile, 'w') as fhs:
+        tpl = load_template(
+            self._t,
+            "@armforge-session-conf.tpl",
+            encoding="utf-8",
+            version=self._forgeversion,
+        )
+        sconf = tpl.substitute(
+            sourcedirs="\n".join(
+                [
+                    "        <directory>{:s}</directory>".format(d)
+                    for d in sources
+                ]
+            )
+        )
+        with open(targetfile, "w") as fhs:
             fhs.write(sconf)
         return targetfile
 
     def ddt_prefix_cmd(self, sources=(), workdir=None):
         """Generate the prefix command required to start DDT."""
         if sources:
-            return [self.ddtpath,
-                    '--session={:s}'.format(self._dump_forge_session(sources, workdir=workdir)),
-                    '--connect']
+            return [
+                self.ddtpath,
+                "--session={:s}".format(
+                    self._dump_forge_session(sources, workdir=workdir)
+                ),
+                "--connect",
+            ]
         else:
-            return [self.ddtpath, '--connect']
+            return [self.ddtpath, "--connect"]