nuclear 2.2.2__tar.gz → 2.2.4__tar.gz

{nuclear-2.2.2 → nuclear-2.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nuclear
-Version: 2.2.2
+Version: 2.2.4
 Summary: Declarative parser for command line interfaces
 Home-page: https://github.com/igrek51/nuclear
 Author: igrek51

{nuclear-2.2.2 → nuclear-2.2.4}/nuclear/sublog/logging.py

@@ -1,34 +1,43 @@
 from contextlib import contextmanager
 from datetime import datetime, timezone
 import logging
+import json
 import os
 import sys
 import threading
-from typing import Dict, Any, Callable
-import json
+import time
+from typing import Dict, Any, Callable, List, Optional
 
 from colorama import init, Fore, Style
 
 from nuclear.sublog.context_error import ContextError
 from nuclear.sublog.exception import extended_exception_details
+from nuclear.utils.collections import coalesce
 from nuclear.utils.env import is_env_flag_enabled
 from nuclear.utils.strings import strip_ansi_colors
 
 LOG_FORMAT = f'{Style.DIM}[%(asctime)s]{Style.RESET_ALL} %(levelname)s %(message)s'
 LOG_DATE_FORMAT = r'%Y-%m-%d %H:%M:%S'
+LOG_DATE_FORMAT_UTC = r'%Y-%m-%d %H:%M:%SZ'
 ISO_DATE_FORMAT = r'%Y-%m-%dT%H:%M:%S.%fZ'
 LOGGING_LOGGER_NAME = 'nuclear.sublog'
-STRUCTURED_LOGGING = is_env_flag_enabled('STRUCTURED_LOGGING', 'false')
 
-log_level: str = os.environ.get('LOG_LEVEL', 'debug')
 simultaneous_print_lock = threading.Lock()
 _logging_logger: logging.Logger = logging.getLogger(LOGGING_LOGGER_NAME)
-_log_state = {
-    'init': False,
-}
+_log_state = {'init': False}
+
 
-def init_logs():
-    """Configure loggers: formatters, handlers and log levels"""
+def init_logs(
+    show_time: Optional[bool] = None,
+    show_log_level: Optional[bool] = None,
+):
+    """
+    Configure loggers: formatters, handlers and log levels
+    :param show_time: True to display formatted time in each log message,
+    False to turn it off, None to use the default
+    :param show_log_level: True to display log level in each log message,
+    False to turn it off, None to use the default
+    """
     logging_kwargs: Dict[str, Any] = {
         'stream': sys.stdout,
         'format': LOG_FORMAT,
@@ -37,22 +46,30 @@ def init_logs():
     }
     if sys.version_info[1] >= 8:
         logging_kwargs['force'] = True
-    if not is_env_flag_enabled('STRUCTURED_LOGGING', 'false'):
+    if is_env_flag_enabled('NUCLEAR_STRUCTURED_LOGGING', 'false'):
+        logging_kwargs['datefmt'] = ISO_DATE_FORMAT
         logging.basicConfig(**logging_kwargs)
         for handler in logging.getLogger().handlers:
-            handler.setFormatter(ColoredFormatter(handler.formatter))
+            handler.setFormatter(StructuredFormatter())
     else:
-        logging_kwargs['datefmt'] = ISO_DATE_FORMAT
+        _show_log_time: bool = coalesce(show_time, is_env_flag_enabled('NUCLEAR_LOG_TIME', 'true'))
+        _show_log_level: bool = coalesce(show_log_level, is_env_flag_enabled('NUCLEAR_LOG_LEVEL_SHOW', 'true'))
         logging.basicConfig(**logging_kwargs)
         for handler in logging.getLogger().handlers:
-            handler.setFormatter(StructuredFormatter(handler.formatter))
+            handler.setFormatter(ColoredFormatter(_show_log_time, _show_log_level))
 
+    log_level: str = os.environ.get('NUCLEAR_LOG_LEVEL', 'debug')
     level = _get_logging_level(log_level)
     root_logger = logging.getLogger(LOGGING_LOGGER_NAME)
     root_logger.setLevel(level)
     _log_state['init'] = True
 
 
+def init_logs_once():
+    if not _log_state['init']:
+        init_logs()
+
+
 def get_logger(logger_name: str) -> logging.Logger:
     """
     Get configured child logger
@@ -65,7 +82,7 @@ def get_logger(logger_name: str) -> logging.Logger:
 class ContextLogger:
     def __init__(self, ctx: Dict[str, Any]):
         self.ctx: Dict[str, Any] = ctx
-        self.structured_logging: bool = STRUCTURED_LOGGING
+        self.structured_logging: bool = is_env_flag_enabled('NUCLEAR_STRUCTURED_LOGGING', 'false')
         self.first_use = True
 
     def error(self, message: str, **ctx):
@@ -147,9 +164,10 @@ def add_context(context_name: str, log: bool = False, **ctx):
 
 
 class ColoredFormatter(logging.Formatter):
-    def __init__(self, plain_formatter):
+    def __init__(self, log_time_show: bool, log_level_show: bool):
         logging.Formatter.__init__(self)
-        self.plain_formatter = plain_formatter
+        self.log_level_show: bool = log_level_show
+        self.log_time_show: bool = log_time_show
 
     log_level_templates = {
         'CRITICAL': f'{Style.BRIGHT + Fore.RED}CRIT {Style.RESET_ALL}',
@@ -160,18 +178,33 @@ class ColoredFormatter(logging.Formatter):
     }
 
     def format(self, record: logging.LogRecord) -> str:
-        if record.levelname in self.log_level_templates:
-            record.levelname = self.log_level_templates[record.levelname].format(record.levelname)
-        line: str = self.plain_formatter.format(record)
+        parts: List[str] = []
+        part_time = self.format_time()
+        if part_time:
+            parts.append(part_time)
+        if self.log_level_show:
+            part_levelname = self.log_level_templates.get(record.levelname, record.levelname)
+            parts.append(part_levelname)
+        parts.append(record.msg)
+        line = ' '.join(parts)
         if not sys.stdout.isatty():
             line = strip_ansi_colors(line)
         return line
+    
+    def format_time(self) -> Optional[str]:
+        if not self.log_time_show:
+            return None
+        now_tz = datetime.now().astimezone()
+        if time.timezone == 0:
+            time_formatted = now_tz.strftime(LOG_DATE_FORMAT_UTC)
+        else:
+            time_formatted = now_tz.strftime(LOG_DATE_FORMAT)
+        return f'{Style.DIM}[{time_formatted}]{Style.RESET_ALL}'
 
 
 class StructuredFormatter(logging.Formatter):
-    def __init__(self, plain_formatter):
+    def __init__(self):
         logging.Formatter.__init__(self)
-        self.plain_formatter = plain_formatter
 
     def format(self, record: logging.LogRecord) -> str:
         timestamp: float = record.created

{nuclear-2.2.2 → nuclear-2.2.4}/nuclear/utils/collections.py

@@ -1,4 +1,4 @@
-from typing import Any, Callable, Iterable, TypeVar, List, Union
+from typing import Any, Callable, Iterable, TypeVar, List, Union, Optional
 
 T = TypeVar('T')
 
@@ -42,3 +42,14 @@ def flatten(collection: Iterable[Union[T, List[T]]]) -> List[T]:
         else:
             flat.append(item)
     return flat
+
+
+def filter_not_none(items: List[Optional[T]]) -> List[T]:
+    return [item for item in items if item is not None]
+
+
+def coalesce(*items: Optional[T]) -> T:
+    for item in items:
+        if item is not None:
+            return item
+    raise ValueError('all items are None')

{nuclear-2.2.2 → nuclear-2.2.4}/nuclear/utils/time.py

@@ -14,6 +14,11 @@ def now() -> datetime:
     return datetime.now(timezone.utc)
 
 
+def now_tz() -> datetime:
+    """Return current datetime with local timezone set"""
+    return datetime.now().astimezone()
+
+
 def now_timestamp() -> int:
     return datetime_to_timestamp(now())
 

nuclear-2.2.4/nuclear/version.py

@@ -0,0 +1 @@
+__version__ = "2.2.4"

{nuclear-2.2.2 → nuclear-2.2.4}/nuclear.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nuclear
-Version: 2.2.2
+Version: 2.2.4
 Summary: Declarative parser for command line interfaces
 Home-page: https://github.com/igrek51/nuclear
 Author: igrek51

nuclear-2.2.2/nuclear/version.py

@@ -1 +0,0 @@
-__version__ = "2.2.2"