fluidattacks_utils_logger 1.0.0__py3-none-any.whl

fluidattacks_utils_logger/__init__.py

@@ -0,0 +1,45 @@
+import sys
+
+import bugsnag
+from fa_purity import (
+    Cmd,
+)
+
+from . import (
+    handlers,
+    logger,
+)
+from .env import (
+    current_app_env,
+)
+from .levels import (
+    LoggingLvl,
+)
+
+__version__ = "1.0.0"
+
+
+def set_main_log(
+    name: str,
+    conf: handlers.LoggingConf,
+    debug: bool,
+    show_time: bool,
+) -> Cmd[None]:
+    _bug_handler = handlers.bug_handler(conf, LoggingLvl.ERROR)
+    _log_handler = handlers.logger_handler(debug, show_time, sys.stderr)
+    _handlers = (_log_handler, _bug_handler)
+    env = current_app_env()
+    display_env = logger.get_logger(name).bind(
+        lambda log: env.bind(lambda e: log.info("%s@%s", (name, e.value))),  # noqa: PLE1206
+    )
+    return (
+        logger.set_logger(name, LoggingLvl.DEBUG if debug else LoggingLvl.INFO, _handlers)
+        + display_env
+    )
+
+
+def start_session() -> Cmd[None]:
+    def _action() -> None:
+        bugsnag.start_session()  # type: ignore[no-untyped-call]
+
+    return Cmd.wrap_impure(_action)

fluidattacks_utils_logger/env.py

@@ -0,0 +1,37 @@
+from enum import (
+    Enum,
+)
+from os import (
+    environ,
+)
+
+from fa_purity import (
+    Cmd,
+)
+
+
+class Envs(Enum):
+    PROD = "production"
+    DEV = "development"
+
+
+def current_app_env() -> Cmd[Envs]:
+    def _action() -> Envs:
+        return Envs(environ.get("OBSERVES_ENV", "production"))
+
+    return Cmd.wrap_impure(_action)
+
+
+def observes_debug() -> Cmd[bool]:
+    def _action() -> bool:
+        _debug = environ.get("OBSERVES_DEBUG", "")
+        return _debug.lower() == "true"
+
+    return Cmd.wrap_impure(_action)
+
+
+def notifier_key() -> Cmd[str]:
+    def _action() -> str:
+        return environ.get("bugsnag_notifier_key", "")  # noqa: SIM112
+
+    return Cmd.wrap_impure(_action)

fluidattacks_utils_logger/handlers.py

@@ -0,0 +1,67 @@
+import logging
+from dataclasses import (
+    dataclass,
+)
+from logging import (
+    Formatter,
+    Handler,
+)
+from typing import (
+    IO,
+)
+
+import bugsnag
+from bugsnag.handlers import (
+    BugsnagHandler,
+)
+from fa_purity import (
+    Cmd,
+)
+
+from fluidattacks_utils_logger.env import (
+    Envs,
+)
+from fluidattacks_utils_logger.levels import (
+    LoggingLvl,
+)
+
+
+@dataclass(frozen=True)
+class LoggingConf:
+    app_type: str
+    app_version: str
+    project_root: str
+    auto_capture_sessions: bool
+    api_key: str
+    release_stage: Envs
+    app_name: str
+
+
+def bug_handler(conf: LoggingConf, min_lvl: LoggingLvl) -> Cmd[Handler]:
+    def _action() -> Handler:
+        bugsnag.configure(  # type: ignore[no-untyped-call]
+            app_type=conf.app_type,
+            app_version=conf.app_version,
+            project_root=conf.project_root,
+            auto_capture_sessions=conf.auto_capture_sessions,
+            api_key=conf.api_key,
+            release_stage=conf.release_stage.value,
+        )
+        handler = BugsnagHandler()  # type: ignore[no-untyped-call]
+        handler.setLevel(min_lvl.value)
+        return handler
+
+    return Cmd.wrap_impure(_action)
+
+
+def logger_handler(debug: bool, show_time: bool, target: IO[str]) -> Cmd[Handler]:
+    def _action() -> Handler:
+        prefix = "%(name)s> " if debug else ""
+        _time = "%(asctime)s " if show_time else ""
+        _format = _time + prefix + "[%(levelname)s] %(message)s"
+        formatter = Formatter(_format)
+        handler = logging.StreamHandler(target)
+        handler.setFormatter(formatter)
+        return handler
+
+    return Cmd.wrap_impure(_action)

fluidattacks_utils_logger/levels.py

@@ -0,0 +1,12 @@
+import logging
+from enum import (
+    Enum,
+)
+
+
+class LoggingLvl(Enum):
+    CRITICAL = logging.CRITICAL
+    ERROR = logging.ERROR
+    WARNING = logging.WARNING
+    INFO = logging.INFO
+    DEBUG = logging.DEBUG

fluidattacks_utils_logger/logger.py

@@ -0,0 +1,54 @@
+import logging
+from dataclasses import (
+    dataclass,
+)
+
+from fa_purity import (
+    Cmd,
+    CmdUnwrapper,
+    FrozenList,
+)
+
+from fluidattacks_utils_logger.levels import (
+    LoggingLvl,
+)
+
+
+@dataclass(frozen=True)
+class _Logger:
+    logger: logging.Logger
+
+
+@dataclass(frozen=True)
+class Logger:
+    _inner: _Logger
+
+    def critical(self, formatted_msg: str, values: FrozenList[str]) -> Cmd[None]:
+        return Cmd.wrap_impure(lambda: self._inner.logger.critical(formatted_msg, *values))
+
+    def debug(self, formatted_msg: str, values: FrozenList[str]) -> Cmd[None]:
+        return Cmd.wrap_impure(lambda: self._inner.logger.debug(formatted_msg, *values))
+
+    def info(self, formatted_msg: str, values: FrozenList[str]) -> Cmd[None]:
+        return Cmd.wrap_impure(lambda: self._inner.logger.info(formatted_msg, *values))
+
+    def warning(self, formatted_msg: str, values: FrozenList[str]) -> Cmd[None]:
+        return Cmd.wrap_impure(lambda: self._inner.logger.warning(formatted_msg, *values))
+
+
+def get_logger(name: str) -> Cmd[Logger]:
+    def _action() -> Logger:
+        log = _Logger(logging.getLogger(name))
+        return Logger(log)
+
+    return Cmd.wrap_impure(_action)
+
+
+def set_logger(name: str, lvl: LoggingLvl, handlers: FrozenList[Cmd[logging.Handler]]) -> Cmd[None]:
+    def _action(unwrapper: CmdUnwrapper) -> None:
+        log = logging.getLogger(name)
+        log.setLevel(lvl.value)
+        for item in handlers:
+            log.addHandler(unwrapper.act(item))
+
+    return Cmd.new_cmd(_action)

fluidattacks_utils_logger-1.0.0.dist-info/METADATA

@@ -0,0 +1,9 @@
+Metadata-Version: 2.4
+Name: fluidattacks_utils_logger
+Version: 1.0.0
+Summary: Common logger handlers
+Author-email: Product Team <development@fluidattacks.com>
+Requires-Python: >=3.11
+Classifier: License :: OSI Approved :: MIT License
+Requires-Dist: bugsnag >=4.7.0, <5.0.0
+Requires-Dist: fa-purity >=2.1.0, <3.0.0

fluidattacks_utils_logger-1.0.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+fluidattacks_utils_logger/__init__.py,sha256=pWxowwy3CXOoRx8YBtPSIluCi1MWEVVLjNreTEF_LPw,987
+fluidattacks_utils_logger/env.py,sha256=g2SkTq-YhI9qdSOT4VGTZlLH1VGbBzPoR4YUvTkilVc,692
+fluidattacks_utils_logger/handlers.py,sha256=Gzn-9Bv7UYOD2Ph0-2r1T86rlj2RlEEzhOCPHT-PqTk,1643
+fluidattacks_utils_logger/levels.py,sha256=hjNMTVY-0669xOWHq6G3jV6dqYZigktalfH7OuqlTGU,210
+fluidattacks_utils_logger/logger.py,sha256=YYCkoIosRXQXVDBoNuV_HFy0Ma_JOil3bd6CchYZ_Xc,1524
+fluidattacks_utils_logger/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fluidattacks_utils_logger-1.0.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+fluidattacks_utils_logger-1.0.0.dist-info/METADATA,sha256=x5LZkuMhAXuWlF8UF_4Pxb03JDjTtP-u23z4BEJH0Y8,314
+fluidattacks_utils_logger-1.0.0.dist-info/RECORD,,

fluidattacks_utils_logger-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: flit 3.12.0
+Root-Is-Purelib: true
+Tag: py3-none-any