vortex-nwp 2.0.0__py3-none-any.whl

vortex/nwp/util/usetnt.py

@@ -0,0 +1,101 @@
+"""
+Usage of the TNT package.
+"""
+
+import codecs
+import io
+
+from bronx.fancies import loggers
+from bronx.syntax.externalcode import ExternalCodeImportChecker
+
+from vortex import sessions
+from vortex.data.stores import FunctionStoreCallbackError
+from vortex.util.roles import setrole
+
+logger = loggers.getLogger(__name__)
+
+tnt_checker = ExternalCodeImportChecker("thenamelisttool")
+with tnt_checker as tnt_register:
+    import thenamelisttool
+
+__all__ = []
+
+
+@tnt_checker.disabled_if_unavailable
+def compose_nam(options):
+    """Use a TNT recipe in order to build a namelist file.
+
+    This function is designed to be executed by a
+    :obj:`vortex.data.stores.FunctionStore` object.
+
+    In order to "execute" the TNT recipe, this function requires a namelist
+    pack to be available in the inputs sequence. By default, this namelist
+    pack should have the "MainNamelistPack" role. This default value can
+    be overriden using the `nampack` attribute of the URI query.
+
+    The recipe file should be named `[source].yaml` where `[source]` stands
+    for the `source` attribute of the obj:`~nwp.data.namelists.Namelist`
+    resource object.
+
+    By defaut, the recipe file is looked for in the namelist pack mentioned
+    above. The role of an alternative pack can be designated using the
+    `dirpack` attribute of the URI.
+
+    :param dict options: All the options passed to the store plus anything from
+                         the query part of the URI.
+
+    :return: Content of a :obj:`nwp.data.namelists.Namelist` resource
+
+    :rtype: A file like object
+    """
+    rhdict = options.get("rhandler", None)
+    source = rhdict["resource"].get("source", None)
+    if source is None:
+        logger.error("Inapropriate type of resource. Got:\n%s", rhdict)
+        raise FunctionStoreCallbackError("Inapropriate type of resources.")
+
+    t = sessions.current()
+
+    def _get_pack_adress(role):
+        role = setrole(role)
+        packlist = [
+            sec.rh for sec in t.context.sequence.filtered_inputs(role=role)
+        ]
+        if len(packlist) != 1:
+            logger.error("The number of namelist packs with role=%s is not 1.")
+            raise FunctionStoreCallbackError(
+                "Incorrect number of namelist packs."
+            )
+        packrh = packlist[0]
+        if packrh.resource.realkind != "namelistpack":
+            logger.error(
+                "Incorrect resource type for role %s. Resource handler:\n%s",
+                role,
+                packrh.icdard(),
+            )
+            raise FunctionStoreCallbackError("Incorrect resource type.")
+        if not packrh.container.filled:
+            logger.error(
+                "The resource handler's container is not filled for role %s",
+                role,
+            )
+            raise FunctionStoreCallbackError("RH container is not filled.")
+        return packrh.container.abspath
+
+    nampack_path = _get_pack_adress(
+        options.get("nampack", "Main Namelist Pack")
+    )
+    dirpack_role = options.get("dirpack", None)
+    dirpack_path = (
+        _get_pack_adress(dirpack_role) if dirpack_role else nampack_path
+    )
+
+    out_io = io.BytesIO()
+    thenamelisttool.util.compose_namelist(
+        t.sh.path.join(dirpack_path, source + ".yaml"),
+        sourcenam_directory=nampack_path,
+        sorting=thenamelisttool.namadapter.FIRST_ORDER_SORTING,
+        squeeze=False,
+        fhoutput=codecs.getwriter("utf-8")(out_io),
+    )
+    return out_io

vortex/proxy.py

@@ -0,0 +1,6 @@
+"""
+Fake module to be populated dynamically, eg. by footprints shortcuts to catalogs.
+"""
+
+#: No automatic export
+__all__ = []

vortex/sessions.py

@@ -0,0 +1,374 @@
+"""
+Vortex Sessions Handling
+
+A :mod:`vortex` session is a virtual identifier gathering information on the current
+#usage of the toolbox. A session has a starting time, and possibly a closing
+time. A session also defines the level of the internal logging used in all
+the vortex modules.
+"""
+
+import logging
+
+from bronx.fancies import loggers
+from bronx.datagrip.datastore import DataStore
+from bronx.patterns import getbytag
+from bronx.stdtypes import date
+import footprints
+
+from vortex.tools.env import Environment
+
+from vortex import gloves as gloves  # footprints import
+from vortex.layout import contexts
+
+#: No automatic export
+__all__ = []
+
+logger = loggers.getLogger(__name__)
+
+
+# Module Interface
+
+
+def get(**kw):
+    """Return actual session ticket object matching description."""
+    if (
+        kw.get("tag", "current") == "current"
+        and Ticket.tag_focus() is not None
+    ):
+        return current()
+    else:
+        return Ticket(**kw)
+
+
+def keys():
+    """Return the list of current session tickets names collected."""
+    return Ticket.tag_keys()
+
+
+def values():
+    """Return the list of current session ticket values collected."""
+    return Ticket.tag_values()
+
+
+def items():
+    """Return the items of the session tickets table."""
+    return Ticket.tag_items()
+
+
+def current():
+    """Return the current active session."""
+    return get(tag=Ticket.tag_focus())
+
+
+def prompt():
+    """Returns a built string that could be used as a prompt for reporting."""
+    return current().prompt
+
+
+def switch(tag=None):
+    """Set the session associated to the actual ``tag`` as active."""
+    return current().switch(tag=tag)
+
+
+def getglove(**kw):
+    """Proxy to :mod:`gloves` collector."""
+    return footprints.proxy.gloves.default(**kw)
+
+
+def system(**kw):
+    """Returns the system associated to the current ticket."""
+    return get(tag=kw.pop("tag", Ticket.tag_focus())).system(**kw)
+
+
+# noinspection PyShadowingBuiltins
+def exit():
+    """Ask all inactive sessions to close, then close the active one."""
+    tags = keys()
+    xtag = Ticket.tag_focus()
+    tags.remove(xtag)
+    tags.append(xtag)
+    ok = True
+    for s in [get(tag=x) for x in tags]:
+        ok = s.exit() and ok
+    return ok
+
+
+class Ticket(getbytag.GetByTag):
+    """
+    Default session ticket class, defined by tag.
+    """
+
+    _tag_default = "root"
+
+    def __init__(
+        self,
+        active=False,
+        topenv=None,
+        glove=None,
+        context=None,
+        datastore=None,
+        prompt="Vortex:",
+    ):
+        self.prompt = prompt
+        self.line = "\n" + "-" * 100 + "\n"
+
+        self._started = date.now()
+        self._closed = 0
+        self._system = None
+
+        if topenv:
+            self._topenv = topenv
+        else:
+            self._topenv = Environment()
+
+        if glove:
+            self._glove = glove
+        else:
+            self._glove = getglove()
+
+        logger.debug("New session system is %s", self.system())
+
+        self._rundir = self.sh.getcwd()
+
+        logger.debug("Open session %s %s", self.tag, self)
+
+        if datastore is None:
+            datastore = DataStore(
+                default_picklefile="{:s}_session_datastore.pickled".format(
+                    self.tag
+                )
+            )
+        self._dstore = datastore
+
+        if context is None:
+            context = contexts.Context(
+                tag=self.tag, topenv=self._topenv, path=self.path
+            )
+        self._last_context = context
+
+        if active:
+            self.catch_focus()
+
+    def _get_rundir(self):
+        """Return the path of the directory associated to current session."""
+        return self._rundir
+
+    def _set_rundir(self, path):
+        """Set a new default rundir for this session."""
+        if self._rundir:
+            logger.warning(
+                "Session <%s> is changing its working directory <%s>",
+                self.tag,
+                self._rundir,
+            )
+        if self.sh.path.isdir(path):
+            self._rundir = path
+            logger.info("Session <%s> set rundir <%s>", self.tag, self._rundir)
+        else:
+            logger.error(
+                "Try to change session <%s> to invalid path <%s>",
+                self.tag,
+                path,
+            )
+
+    rundir = property(_get_rundir, _set_rundir)
+
+    @property
+    def active(self):
+        """Return whether this session is active or not."""
+        return self.has_focus()
+
+    @property
+    def started(self):
+        """Return opening time stamp."""
+        return self._started
+
+    @property
+    def closed(self):
+        """Return closing time stamp if any."""
+        return self._closed
+
+    @property
+    def opened(self):
+        """Boolean. True if the session is not closed."""
+        return not bool(self.closed)
+
+    @property
+    def topenv(self):
+        """Return top environment binded to this session."""
+        return self._topenv
+
+    @property
+    def env(self):
+        """Return environment binded to current active context."""
+        return self.context.env
+
+    @property
+    def sh(self):
+        """Return shell interface binded to current active context."""
+        return self._system
+
+    @property
+    def glove(self):
+        """Return the default glove associated to this session."""
+        return self._glove
+
+    @property
+    def context(self):
+        """Returns the active or latest context binded to this section."""
+        if self.active:
+            return contexts.current()
+        else:
+            return self._last_context
+
+    @property
+    def datastore(self):
+        return self._dstore
+
+    def system(self, **kw):
+        """
+        Returns the current OS handler used or set a new one according
+        to ``kw`` dictionary-like arguments.
+        """
+        refill = kw.pop("refill", False)
+        if not self._system or kw or refill:
+            self._system = footprints.proxy.system(glove=self.glove, **kw)
+            if not self._system:
+                logger.critical(
+                    "Could not load a system object with description %s",
+                    str(kw),
+                )
+        return self._system
+
+    def duration(self):
+        """
+        Time since the opening of the session if still opened
+        or complete duration time if closed.
+        """
+        if self.closed:
+            return self.closed - self.started
+        else:
+            return date.now() - self.started
+
+    def activate(self):
+        """Force the current session as active."""
+        if self.opened:
+            return self.switch(self.tag)
+        else:
+            return False
+
+    def close(self):
+        """Closes the current session."""
+        if self.closed:
+            logger.warning(
+                "Session %s already closed at %s", self.tag, self.closed
+            )
+        else:
+            self._closed = date.now()
+            logger.debug(
+                "Close session %s ( time = %s )", self.tag, self.duration()
+            )
+
+    @property
+    def path(self):
+        return "/" + self.tag
+
+    @property
+    def subcontexts(self):
+        """The current contexts binded to this session."""
+        rootpath = self.path + "/"
+        return [x for x in contexts.values() if x.path.startswith(rootpath)]
+
+    def exit(self):
+        """Exit from the current session."""
+        ok = True
+        logger.debug("Exit session %s %s", self.tag, self)
+        for kid in self.subcontexts:
+            logger.debug("Exit from context %s", kid)
+            ok = ok and kid.exit()
+        if self.opened:
+            self.close()
+        return ok
+
+    def warning(self):
+        """Switch current loglevel to WARNING."""
+        self.setloglevel(logging.WARNING)
+
+    def debug(self):
+        """Switch current loglevel to DEBUG."""
+        self.setloglevel(logging.DEBUG)
+
+    def info(self):
+        """Switch current loglevel to INFO."""
+        self.setloglevel(logging.INFO)
+
+    def error(self):
+        """Switch current loglevel to ERROR."""
+        self.setloglevel(logging.ERROR)
+
+    def critical(self):
+        """Switch current loglevel to CRITICAL."""
+        self.setloglevel(logging.CRITICAL)
+
+    def setloglevel(self, level):
+        """
+        Explicitly sets the logging level to the ``level`` value.
+        Shortcuts such as :method::`debug' or :method:`error` should be used.
+        """
+        loggers.setGlobalLevel(level)
+
+    @property
+    def loglevel(self):
+        """
+        Returns the logging level.
+        """
+        v_logger = loggers.getLogger("vortex")
+        return logging.getLevelName(v_logger.getEffectiveLevel())
+
+    def idcard(self, indent="+ "):
+        """Returns a printable description of the current session."""
+        card = "\n".join(
+            (
+                "{0}Name     = {1:s}",
+                "{0}Started  = {2!s}",
+                "{0}Opened   = {3!s}",
+                "{0}Duration = {4!s}",
+                "{0}Loglevel = {5:s}",
+            )
+        ).format(
+            indent,
+            self.tag,
+            self.started,
+            self.opened,
+            self.duration(),
+            self.loglevel,
+        )
+        return card
+
+    def focus_gain_hook(self):
+        """Activate the appropriate context."""
+        super().focus_gain_hook()
+        self._last_context.catch_focus()
+
+    def focus_loose_hook(self):
+        """Keep track of the latest context."""
+        super().focus_loose_hook()
+        self._last_context = self.context
+
+    @classmethod
+    def switch(cls, tag=None):
+        """
+        Allows the user to switch to an other session,
+        assuming that the provided tag is already known.
+        """
+        if tag in cls.tag_keys():
+            obj = Ticket(tag=tag)
+            obj.catch_focus()
+            return obj
+        else:
+            logger.error("Try to switch to an undefined session: %s", tag)
+            return None
+
+    def __del__(self):
+        if self.opened:
+            self.close()

vortex/syntax/__init__.py

@@ -0,0 +1,9 @@
+"""
+The :mod:`vortex` syntax mostly deals with attributes resolution and arguments expansion.
+The most important usage is done by :class:`FootprintBase` derivated objects.
+"""
+
+#: No automatic export
+__all__ = []
+
+__tocinfoline__ = "VORTEX package where standard attributes are defined."