Merge pull request #19 from MC-kit/devel

Devel

Author: dvp2015

dev/reset-pyenv

@@ -1,9 +1,9 @@
 #!/bin/bash
 
-set -exu
+# set -exu
 
 pyenv virtualenv-delete -f  mapstp
-pyenv virtualenv 3.9.7 mapstp
+pyenv virtualenv 3.10.0 mapstp
 poetry install
 pyenv rehash
 mapstp --version

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "mapstp"
-version = "0.3.1"
+version = "0.3.2"
 description = "Transfers meta information from STP to MCNP"
 authors = ["dvp <[email protected]>"]
 homepage = "https://github.com/MC-kit/map-stp"
@@ -38,6 +38,7 @@ click = "^8.0.1"
 pandas = "^1.3.4"
 openpyxl = "^3.0.9"
 numpy = "^1.21.4"
+loguru = "^0.5.3"
 
 [tool.poetry.dev-dependencies]
 pytest = "^6.2.5"

pyproject.toml

@@ -3,9 +3,15 @@
 See https://github.com/Delgan/loguru
 
 """
+from typing import Final, Optional
+
 import logging
+import sys
+
+from pathlib import Path
 
 from loguru import logger
+from mapstp.config import env
 
 # class PropagateHandler(logging.Handler):
 #     """Send events from loguru to standard logging"""
@@ -47,3 +53,42 @@ def emit(self, record: logging.LogRecord) -> None:
 # log.setLevel(0)
 log.addHandler(InterceptHandler())
 # logging.basicConfig(handlers=[InterceptHandler()], level=0, style='{')
+
+# from loguru._defaults.py
+# "<green>{time:YYYY-MM-DD HH:mm:ss.SSS}</green> | "
+# "<level>{level: <8}</level> | "
+# "<cyan>{name}</cyan>:<cyan>{function}</cyan>:<cyan>{line}</cyan> - <level>{message}</level>",
+
+MAPSTP_CONSOLE_LOG_FORMAT: Final[str] = env(
+    "MAPSTP_CONSOLE_LOG_FORMAT",
+    default="<green>{time:YYYY-MM-DD HH:mm:ss}</green> | "
+    "<level>{level: <8}</level> | "
+    "<level>{message}</level>",
+)
+MAPSTP_FILE_LOG_PATH: Final[Path] = env(
+    "MAPSTP_FILE_LOG_PATH", type_=Path, default="mapstp.log"
+)
+
+
+def init_logger(
+    *,
+    stderr_format: Optional[str] = MAPSTP_CONSOLE_LOG_FORMAT,
+    log_path: Optional[Path] = MAPSTP_FILE_LOG_PATH,
+) -> None:
+    """Configure logger with given parameters.
+
+    Args:
+        stderr_format: log message format for stderr handler, if None, no stderr logging.
+        log_path: path to file for logging, if None, no file logging.
+    """
+    logger.remove()
+    if stderr_format:
+        logger.add(
+            sys.stderr,
+            format=stderr_format,
+            level="INFO",
+            backtrace=False,
+            diagnose=False,
+        )
+    if log_path:
+        logger.add(log_path, rotation="100 MB", backtrace=True, diagnose=True)

src/mapstp/cli/logging.py

@@ -4,7 +4,7 @@
 of STP paths to STP components, corresponding to cells
 in MCNP model, would it be generated from the STP with SuperMC.
 
-The excel also contains material numbers, densities, correction factors,
+The Excel also contains material numbers, densities, correction factors,
 and RWCL id. The values can be specified in the names of STP
 components as special tags. A tag is denoted with bracket enclosed
 specification at the end of component name: "Component name [<spec>]".
@@ -27,42 +27,15 @@
 
 from mapstp import __name__ as package_name
 from mapstp import __summary__, __version__
+from mapstp.cli.logging import init_logger, logger
 from mapstp.excel import create_excel
 from mapstp.materials import get_used_materials, load_materials_map
 from mapstp.merge import correct_start_cell_number, join_paths, merge_paths
 from mapstp.utils.io import can_override, select_output
-
-# TODO dvp: add customized configuring from a configuration toml-file.
 from mapstp.workflow import create_path_info
 
-# from .logging import logger
-# from click_loguru import ClickLoguru
-
-
-# LOG_FILE_RETENTION = 3
-# NO_LEVEL_BELOW = 30
-#
-#
-# def stderr_log_format_func(msg_dict):
-#     """Do level-sensitive formatting.
-#
-#     Just a copy from click-loguru so far."""
-#
-#     if msg_dict["level"].no < NO_LEVEL_BELOW:
-#         return "<level>{message}</level>\n"
-#     return "<level>{level}</level>: <level>{message}</level>\n"
-#
-#
-# click_loguru = ClickLoguru(
-#     NAME,
-#     VERSION,
-#     stderr_format_func=stderr_log_format_func,
-#     retention=LOG_FILE_RETENTION,
-#     log_dir_parent=".logs",
-#     timer_log_level="info",
-# )
-
 
+# TODO dvp: add customized configuring from a configuration toml-file.
 @dataclass
 class Config:
     override: bool = False
@@ -83,13 +56,7 @@ class Config:
 """
 
 
-# @click_loguru.logging_options
-# @click.group(help=meta.__summary__, name=NAME)
-
-
 @click.command(help=_USAGE, name=package_name)
-# @click_loguru.init_logger()
-# @click_loguru.stash_subcommand()
 @click.option(
     "--override/--no-override",
     default=False,
@@ -154,9 +121,8 @@ class Config:
     required=False,
 )
 @click.version_option(__version__, prog_name=package_name)
-# @logger.catch(reraise=True)
+@click.help_option()
 @click.pass_context
-# ctx, verbose: bool, quiet: bool, logfile: bool, profile_mem: bool, override: bool
 def mapstp(
     ctx,
     override: bool,
@@ -190,16 +156,9 @@ def mapstp(
         raise click.UsageError(
             "Nor `excel`, neither `mcnp` parameter is specified - nothing to do"
         )
-    # if quiet:
-    #     logger.level("WARNING")
-    # if verbose:
-    #     logger.level("TRACE")
-    # logger.info("Running {}", NAME)
-    # logger.debug("Working dir {}", Path(".").absolute())
-
-    #
+    init_logger()
+    logger.info("Running mapstp {}", __version__)
     cfg = ctx.ensure_object(Config)
-    # obj["DEBUG"] = debug
     cfg.override = override
     paths, path_info = create_path_info(materials_index, stp)
     materials_map = load_materials_map(materials) if materials else None
@@ -208,6 +167,7 @@ def mapstp(
     )
     if mcnp:
         _mcnp = Path(mcnp)
+        logger.info("Tagging model {}", mcnp)
         with select_output(override, output) as _output:
             joined_paths = join_paths(paths, separator)
             merge_paths(_output, joined_paths, path_info, _mcnp, used_materials_text)
@@ -216,9 +176,8 @@ def mapstp(
         _excel = Path(excel)
         can_override(_excel, override)
         create_excel(_excel, paths, path_info, separator, start_cell_number)
-
-
-# TODO dvp: add logging
+        logger.info("Accompanying excel is saved to {}", _excel)
+    logger.success("mapstp finished")
 
 
 if __name__ == "__main__":

src/mapstp/cli/runner.py

@@ -0,0 +1,76 @@
+"""Configuration tools."""
+
+from typing import Any, Type
+
+from os import environ
+
+
+def _make_bool(key: str, val: str) -> bool:
+    val = val.lower()
+    if val in ["1", "true", "yes", "y", "ok", "on"]:
+        return True
+    if val in ["0", "false", "no", "n", "nok", "off"]:
+        return False
+    raise ValueError(
+        f"Invalid environment variable '{key}': expected a boolean, found '{val}'"
+    )
+
+
+def _make_int(key: str, val: str) -> int:
+    try:
+        return int(val)
+    except ValueError:
+        raise ValueError(
+            f"Invalid environment variable '{key}': expected an integer, found '{val}'"
+        ) from None
+
+
+def _make_float(key: str, val: str) -> float:
+    try:
+        return float(val)
+    except ValueError:
+        raise ValueError(
+            f"Invalid environment variable '{key}': expected a float, found '{val}'"
+        ) from None
+
+
+def env(key: str, type_: Type[Any] = str, default: Any = None) -> Any:
+    """Retrieve environment variable and convert to specified type with proper diagnostics.
+
+    Args:
+        key: environment variable name
+        type_: type to convert to
+        default: value to use, if there are no variable with the name `key`
+
+    Returns:
+        Loaded value converted to `type_` or default.
+
+    Raises:
+        ValueError: if conversion is not possible.
+    """
+    if key not in environ:
+        return default
+
+    val = environ[key]
+
+    if type_ == str:
+        return val
+
+    if type_ == bool:
+        return _make_bool(key, val)
+
+    if type_ == int:
+        return _make_int(key, val)
+
+    if type_ == float:
+        return _make_float(key, val)
+
+    try:
+        return type_(val)
+    except ValueError:
+        raise ValueError(
+            f"Invalid environment variable '{key}': conversion {type_.__name__}({val}) failed."
+        ) from None
+
+
+# MAPSTP_AUTOINIT: Final[bool] = env("MAPSTP_AUTOINIT", bool, True)