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

vortex/gloves.py

@@ -18,45 +18,45 @@ class Glove(footprints.FootprintBase):
     """Base class for GLObal Versatile Environment."""
 
     _abstract = True
-    _collector = ('glove',)
+    _collector = ("glove",)
     _footprint = dict(
-        info = 'Abstract glove',
-        attr = dict(
-            email = dict(
-                alias    = ['address'],
-                optional = True,
-                default  = Environment(active=False)['email'],
-                access   = 'rwx',
+        info="Abstract glove",
+        attr=dict(
+            email=dict(
+                alias=["address"],
+                optional=True,
+                default=Environment(active=False)["email"],
+                access="rwx",
             ),
-            vapp = dict(
-                optional = True,
-                default  = 'play',
-                access   = 'rwx',
+            vapp=dict(
+                optional=True,
+                default="play",
+                access="rwx",
             ),
-            vconf = dict(
-                optional = True,
-                default  = 'sandbox',
-                access   = 'rwx',
+            vconf=dict(
+                optional=True,
+                default="sandbox",
+                access="rwx",
             ),
-            tag = dict(
-                optional = True,
-                default  = 'default',
+            tag=dict(
+                optional=True,
+                default="default",
             ),
-            user = dict(
-                alias    = ('logname', 'username'),
-                optional = True,
-                default  = Environment(active=False)['logname']
+            user=dict(
+                alias=("logname", "username"),
+                optional=True,
+                default=Environment(active=False)["logname"],
             ),
-            profile = dict(
-                alias    = ('kind', 'membership'),
-                values   = ['oper', 'dble', 'test', 'research', 'tourist'],
-                remap    = dict(tourist = 'research')
-            )
-        )
+            profile=dict(
+                alias=("kind", "membership"),
+                values=["oper", "dble", "test", "research", "tourist"],
+                remap=dict(tourist="research"),
+            ),
+        ),
     )
 
     def __init__(self, *args, **kw):
-        logger.debug('Glove abstract %s init', self.__class__)
+        logger.debug("Glove abstract %s init", self.__class__)
         super().__init__(*args, **kw)
         self._rmdepthmin = 3
         self._siteroot = None
@@ -70,32 +70,32 @@ class Glove(footprints.FootprintBase):
     @property
     def realkind(self):
         """Returns the litteral string identity of the current glove."""
-        return 'glove'
+        return "glove"
 
     @property
     def configrc(self):
         """Returns the path of the default directory where ``.ini`` files are stored."""
-        return Environment(active=False).HOME + '/.vortexrc'
+        return Environment(active=False).HOME + "/.vortexrc"
 
     @property
     def siteroot(self):
         """Returns the path of the vortex install directory."""
         if not self._siteroot:
-            self._siteroot = '/'.join(__file__.split('/')[0:-3])
+            self._siteroot = "/".join(__file__.split("/")[0:-3])
         return self._siteroot
 
     @property
     def siteconf(self):
         """Returns the path of the default directory where ``.ini`` files are stored."""
         if not self._siteconf:
-            self._siteconf = '/'.join((self.siteroot, 'conf'))
+            self._siteconf = "/".join((self.siteroot, "conf"))
         return self._siteconf
 
     @property
     def sitedoc(self):
         """Returns the path of the default directory where ``.ini`` files are stored."""
         if not self._sitedoc:
-            self._sitedoc = '/'.join((self.siteroot, 'sphinx'))
+            self._sitedoc = "/".join((self.siteroot, "sphinx"))
         return self._sitedoc
 
     @property
@@ -103,8 +103,8 @@ class Glove(footprints.FootprintBase):
         """Returns the path of the default directory where ``.ini`` files are stored."""
         if not self._sitesrc:
             self._sitesrc = (
-                '/'.join((self.siteroot, 'site')),
-                '/'.join((self.siteroot, 'src'))
+                "/".join((self.siteroot, "site")),
+                "/".join((self.siteroot, "src")),
             )
         return self._sitesrc
 
@@ -120,8 +120,9 @@ class Glove(footprints.FootprintBase):
         """Refresh actual email with current username and provided ``domain``."""
         if domain is None:
             from vortex import sessions
+
             domain = sessions.system().getfqdn()
-        return '@'.join((self.user, domain))
+        return "@".join((self.user, domain))
 
     @property
     def xmail(self):
@@ -156,14 +157,16 @@ class Glove(footprints.FootprintBase):
             if self._ftduser:
                 return self._ftduser
             else:
-                return Environment.current().get('VORTEX_ARCHIVE_USER',
-                                                 self.user if defaults_to_user else None)
+                return Environment.current().get(
+                    "VORTEX_ARCHIVE_USER",
+                    self.user if defaults_to_user else None,
+                )
 
     def _get_default_fthost(self):
         if self._ftdhost:
             return self._ftdhost
         else:
-            return Environment.current().get('VORTEX_ARCHIVE_HOST', None)
+            return Environment.current().get("VORTEX_ARCHIVE_HOST", None)
 
     def _set_default_fthost(self, value):
         self._ftdhost = value
@@ -171,31 +174,57 @@ class Glove(footprints.FootprintBase):
     def _del_default_fthost(self):
         self._ftdhost = None
 
-    default_fthost = property(_get_default_fthost, _set_default_fthost, _del_default_fthost)
+    default_fthost = property(
+        _get_default_fthost, _set_default_fthost, _del_default_fthost
+    )
 
-    def describeftsettings(self, indent='+ '):
+    def describeftsettings(self, indent="+ "):
         """Returns a printable description of default file transfert usernames."""
         card = "\n".join(
-            ['{0}{3:48s} = {4:s}', ] +
-            ['{0}{1:48s} = {2:s}', ] +
-            (['{0}Host specific FT users:', ] if self._ftusers else []) +
-            ['{0}' + '  {:46s} = {:s}'.format(k, v) for k, v in self._ftusers.items() if v]
-        ).format(indent,
-                 'Default FT User', str(self._ftduser),
-                 'Default FT Host', str(self._ftdhost))
+            [
+                "{0}{3:48s} = {4:s}",
+            ]
+            + [
+                "{0}{1:48s} = {2:s}",
+            ]
+            + (
+                [
+                    "{0}Host specific FT users:",
+                ]
+                if self._ftusers
+                else []
+            )
+            + [
+                "{0}" + "  {:46s} = {:s}".format(k, v)
+                for k, v in self._ftusers.items()
+                if v
+            ]
+        ).format(
+            indent,
+            "Default FT User",
+            str(self._ftduser),
+            "Default FT Host",
+            str(self._ftdhost),
+        )
         return card
 
-    def idcard(self, indent='+ '):
+    def idcard(self, indent="+ "):
         """Returns a printable description of the current glove."""
-        card = "\n".join((
-            '{0}User     = {1:s}',
-            '{0}Profile  = {2!s}',
-            '{0}Vapp     = {3:s}',
-            '{0}Vconf    = {4:s}',
-            '{0}Configrc = {5:s}'
-        )).format(
+        card = "\n".join(
+            (
+                "{0}User     = {1:s}",
+                "{0}Profile  = {2!s}",
+                "{0}Vapp     = {3:s}",
+                "{0}Vconf    = {4:s}",
+                "{0}Configrc = {5:s}",
+            )
+        ).format(
             indent,
-            self.user, self.profile, self.vapp, self.vconf, self.configrc
+            self.user,
+            self.profile,
+            self.vapp,
+            self.vconf,
+            self.configrc,
         )
         return card
 
@@ -211,19 +240,19 @@ class ResearchGlove(Glove):
 
     _explicit = False
     _footprint = dict(
-        info = 'Research glove',
-        attr = dict(
-            profile = dict(
-                optional = True,
-                values   = ['research', 'tourist'],
-                default  = 'research',
+        info="Research glove",
+        attr=dict(
+            profile=dict(
+                optional=True,
+                values=["research", "tourist"],
+                default="research",
             )
-        )
+        ),
     )
 
     @property
     def realkind(self):
-        return 'research'
+        return "research"
 
 
 class OperGlove(Glove):
@@ -236,40 +265,38 @@ class OperGlove(Glove):
     """
 
     _footprint = dict(
-        info = 'Operational glove',
-        attr = dict(
-            user = dict(
-                values   = ['mxpt001']
+        info="Operational glove",
+        attr=dict(
+            user=dict(values=["mxpt001"]),
+            profile=dict(
+                optional=False,
+                values=["oper", "dble", "test", "miroir"],
             ),
-            profile = dict(
-                optional = False,
-                values   = ['oper', 'dble', 'test', 'miroir'],
-            )
-        )
+        ),
     )
 
     @property
     def realkind(self):
-        return 'opuser'
+        return "opuser"
 
 
 class UnitTestGlove(ResearchGlove):
     """A very special glove for unit-tests."""
 
     _footprint = dict(
-        info = 'Unit-Test Glove',
-        attr = dict(
-            profile = dict(
-                optional = False,
-                values   = ['utest'],
+        info="Unit-Test Glove",
+        attr=dict(
+            profile=dict(
+                optional=False,
+                values=["utest"],
             ),
-            test_configrc = dict(
-                optional = False,
+            test_configrc=dict(
+                optional=False,
             ),
-            test_siteroot = dict(
-                optional = False,
+            test_siteroot=dict(
+                optional=False,
             ),
-        )
+        ),
     )
 
     def __init__(self, *args, **kw):

vortex/layout/__init__.py

@@ -12,16 +12,9 @@ a VORTEX session:
       the list of sections and environment variables ;
     * the :mod:`monitor` module defines utility classes to monitor the state of an
       ensemble of :class:`~dataflow.Section` objects.
-
-It also provides modules that allows to create "standard" VORTEX's jobs:
-
-    * the :mod:`nodes` modules defines a bunch of classes that helps to organise
-      VORTEX jobs (creating tasks, families of tasks, ...);
-    * the :mod:`jobs` module focuses on the actual job generation and initialisation.
-
 """
 
 #: No automatic export
 __all__ = []
 
-__tocinfoline__ = 'Package that helps organising a VORTEX session.'
+__tocinfoline__ = "Package that helps organising a VORTEX session."