prerelease changes in package

vertok · vertok · commit 0c48ab3f9819 · 2025-04-20T15:05:57.000+02:00
diff --git a/docs/source/installation.rst b/docs/source/installation.rst
@@ -77,8 +77,8 @@ Configure logging using command-line arguments:
     # Use configuration file
     python your_script.py --log-config config.yaml
 
-    # Disable exit on critical errors
-    python your_script.py --no-exit-on-critical
+    # Activate exit on critical errors
+    python your_script.py --exit-on-critical
 
     # Disable colored output
     python your_script.py --no-color
@@ -97,8 +97,8 @@ Available Arguments
 --log-config FILE
     Use YAML configuration file
 
---no-exit-on-critical
-    Prevent program termination on critical errors
+--exit-on-critical
+    Terminate program on critical errors
 
 --no-color
     Disable colored console output
diff --git a/docs/source/usage.rst b/docs/source/usage.rst
@@ -50,8 +50,8 @@ Common Arguments
 --log-config FILE
     Use a YAML configuration file for logging settings
 
---no-exit-on-critical
-    Prevent program termination on critical errors
+--exit-on-critical
+    Terminate program on critical errors
 
 --no-color
     Disable colored console output
@@ -84,7 +84,7 @@ YAML Configuration:
    log_dir: logs
    rotation_size_mb: 10
    backup_count: 5
-   exit_on_critical: true
+   exit_on_critical: false
 
    # Control third-party libraries
    external_loggers:
diff --git a/example/config_showcase.py b/example/config_showcase.py
@@ -25,8 +25,8 @@
   # Custom log format:
   python config_showcase.py --log-format "%(asctime)s [%(levelname)s] %(message)s"
 
-  # Disable exit on critical:
-  python config_showcase.py --no-exit-on-critical
+  # Activate exit on critical:
+  python config_showcase.py --exit-on-critical
 
   # Customize log directory:
   python config_showcase.py --log-dir ./my_logs
@@ -36,10 +36,11 @@
 from time import sleep
 
 from prismalog import LoggingConfig, get_logger
-from prismalog.argparser import get_argument_parser, extract_logging_args
+from prismalog.argparser import extract_logging_args, get_argument_parser
 
 
-def main():
+def main() -> None:
+    """Main function to demonstrate prismalog configuration keys."""
     # Get the standard argument parser
     parser = get_argument_parser(description="prismalog Configuration Showcase")
 
@@ -103,7 +104,7 @@ def main():
     exit_on_critical = LoggingConfig.get("exit_on_critical")
     log.info(f"8. exit_on_critical = {exit_on_critical}")
     log.info(f"   Whether to terminate the program on critical logs")
-    log.info(f"   Set with: --no-exit-on-critical to disable")
+    log.info(f"   Set with: --exit-on-critical to activate")
 
     # 9. test_mode - For testing the logger itself
     test_mode = LoggingConfig.get("test_mode")
@@ -124,14 +125,15 @@ def main():
     # Demonstrate exit_on_critical
     if exit_on_critical:
         log.info("\nAbout to log a CRITICAL message, which will terminate the program")
-        log.info("To prevent termination, run with: --no-exit-on-critical")
-        sleep(1)  # Give user time to read
+        log.info("This happens because you used: --exit-on-critical")
+        sleep(1)
         log.critical("This is a CRITICAL message - program will exit now")
     else:
-        log.info("\nCRITICAL messages won't terminate the program (--no-exit-on-critical was used)")
+        log.info("\nCRITICAL messages won't terminate the program (default behavior)")
         log.critical("This is a CRITICAL message - program continues")
         log.info("Program completed successfully")
+        log.info("To change this behavior, use --exit-on-critical")
 
 
 if __name__ == "__main__":
-    main()
+    main()
diff --git a/example/example_script.py b/example/example_script.py
@@ -20,10 +20,12 @@
     # Run with custom configuration:
     python example_script.py --log-config path/to/config.yaml
 
-    # Run with critical messages allowed (no exit):
-    python example_script.py --no-exit-on-critical
+    # Run with critical messages allowed to exit:
+    python example_script.py --exit-on-critical
 """
 
+from time import sleep
+
 from prismalog.argparser import extract_logging_args, get_argument_parser
 from prismalog.log import LoggingConfig, get_logger
 
@@ -47,10 +49,12 @@ def main() -> None:
 
     # Create logger
     logger = get_logger("example")
+    exit_on_critical = logging_args.get("exit_on_critical", True)
+    log_level = logging_args.get("default_level", "INFO")
 
     # Example usage - show current settings
-    logger.info(f"Current log level: {logging_args.get('default_level', 'INFO')}")
-    logger.info(f"Exit on critical: {not logging_args.get('exit_on_critical', True)}")
+    logger.info("Current log level: %s", log_level)
+    logger.info("Exit on critical: %s", exit_on_critical)
 
     # Demonstrate different log levels
     logger.debug("This is a debug message")
@@ -59,13 +63,18 @@ def main() -> None:
     logger.error("This is an error message")
 
     # Warn user about potential program termination
-    if logging_args.get("exit_on_critical", True):
-        logger.warning("About to log a CRITICAL message which will terminate the program")
-        logger.warning("(Use --no-exit-on-critical to prevent termination)")
+    if exit_on_critical:
+        logger.info("\nAbout to log a CRITICAL message, which will terminate the program")
+        logger.info("This happens because you used: --exit-on-critical")
+        sleep(1)
+        logger.critical("This is a CRITICAL message - program will exit now")
     else:
-        logger.info("Program will continue after critical message")
+        logger.info("\nCRITICAL messages won't terminate the program (default behavior)")
+        logger.critical("This is a CRITICAL message - program continues")
+        logger.info("Program completed successfully")
+        logger.info("To change this behavior, use --exit-on-critical")
 
-    # This will terminate the program if exit_on_critical is true
+    # This will not terminate the program since exit_on_critical is false
     logger.critical("This is a critical message")
 
     # These will only be reached if exit_on_critical is false
diff --git a/example/integrations/nltk_example/nltk_example.py b/example/integrations/nltk_example/nltk_example.py
@@ -24,14 +24,20 @@
     python nltk_example.py --log-level DEBUG
 """
 
+from typing import TYPE_CHECKING, Union
+
+if TYPE_CHECKING:
+    from logging import Logger
+    from prismalog.log import ColoredLogger
+
 import nltk  # type: ignore
 from nltk.tokenize import word_tokenize  # type: ignore
 
-from prismalog.log import LoggingConfig, get_logger
 from prismalog.argparser import extract_logging_args, get_argument_parser
+from prismalog.log import LoggingConfig, get_logger
 
 
-def download_nltk_data(logger) -> bool:
+def download_nltk_data(logger: Union["Logger", "ColoredLogger"]) -> bool:
     """
     Download NLTK data with logging configuration from config file or CLI args.
 
@@ -41,7 +47,7 @@ def download_nltk_data(logger) -> bool:
     # Log configuration info
     config_file = LoggingConfig.get("config_file", None)
     if config_file:
-        logger.info(f"Using configuration from: {config_file}")
+        logger.info("Using configuration from: %s", config_file)
     else:
         logger.info("Using default configuration")
 
diff --git a/example/integrations/nltk_example/requirements.txt b/example/integrations/nltk_example/requirements.txt
@@ -1 +1 @@
-nltk>=3.9.1
+nltk>=3.9.1
diff --git a/prismalog/__init__.py b/prismalog/__init__.py
@@ -6,7 +6,7 @@
 from typing import Optional
 
 from .config import LoggingConfig
-from .log import ColoredLogger, ColoredFormatter, MultiProcessingLog, CriticalExitHandler, get_logger
+from .log import ColoredFormatter, ColoredLogger, CriticalExitHandler, MultiProcessingLog, get_logger
 
 
 def setup_logging(config_file: Optional[str] = None, use_cli_args: bool = True) -> dict:
diff --git a/prismalog/argparser.py b/prismalog/argparser.py
@@ -22,7 +22,7 @@
 --log-format           Format string for log messages
 --no-color             Disable colored console output
 --disable-rotation     Disable log file rotation
---no-exit-on-critical  Don't exit program on critical errors
+--exit-on-critical     Exit program on critical errors
 --rotation-size        Log file rotation size in MB
 --backup-count         Number of backup log files to keep
 
@@ -64,7 +64,7 @@
 """
 
 import argparse
-from typing import Dict, Any, Optional
+from typing import Any, Dict, Optional
 
 
 class LoggingArgumentParser:
@@ -113,10 +113,10 @@ def add_arguments(parser: Optional[argparse.ArgumentParser] = None) -> argparse.
         )
 
         parser.add_argument(
-            "--no-exit-on-critical",
+            "--exit-on-critical",
             dest="exit_on_critical",
-            action="store_false",
-            help="Don't exit program on critical errors",
+            action="store_true",
+            help="Exit the program on critical errors",
         )
 
         # Numeric options
diff --git a/prismalog/config.py b/prismalog/config.py
@@ -107,7 +107,7 @@ class LoggingConfig:
         "log_format": "%(asctime)s - %(filename)s - %(name)s - [%(levelname)s] - %(message)s",
         "colored_console": True,
         "disable_rotation": False,
-        "exit_on_critical": True,  # Whether to exit the program on critical logs
+        "exit_on_critical": False,  # Whether to exit the program on critical logs
         "test_mode": False,  # Whether the logger is running in test mode
     }
 
diff --git a/prismalog/log.py b/prismalog/log.py
@@ -683,7 +683,7 @@ def critical(self, msg: str, *args: Any, **kwargs: Any) -> None:
         """
         Logs a critical message.
 
-        Note: If exit_on_critical=True in config (default), this will terminate the program.
+        Note: If exit_on_critical=True in config, this will terminate the program.
 
         Args:
             msg: The message to log
diff --git a/tests/test_config.py b/tests/test_config.py
@@ -242,7 +242,7 @@ def test_default_used_when_no_env_or_yaml(self):
         """Test that default values are used when no other sources are specified."""
         LoggingConfig.reset()
         LoggingConfig.initialize(config_file=None, use_cli_args=False)
-        assert LoggingConfig.get("exit_on_critical") is True
+        assert LoggingConfig.get("exit_on_critical") is False
 
     def test_type_conversion_for_booleans(self):
         """Test boolean type conversion from different string representations."""
diff --git a/tests/test_config_priority.py b/tests/test_config_priority.py
@@ -12,17 +12,17 @@
 4. Environment variables with lower priority than CLI/YAML
 """
 
+import argparse
 import os
 import sys
 import tempfile
-import argparse
 from pathlib import Path
 
 # Add project root to path
 sys.path.insert(0, str(Path(__file__).parent.parent))
 
-from prismalog.log import LoggingConfig, get_logger
 from prismalog.argparser import extract_logging_args, get_argument_parser
+from prismalog.log import LoggingConfig, get_logger
 
 
 def create_test_config(config_content):
diff --git a/tests/test_config_processing.py b/tests/test_config_processing.py
@@ -5,16 +5,17 @@
 from various sources including environment variables, command-line arguments, and configuration files.
 """
 
+import argparse
+import io
+import logging
 import os
 import re
-import tempfile
-import io
 import sys
-import logging
-import pytest
-import argparse
+import tempfile
 from unittest.mock import patch
 
+import pytest
+
 from prismalog.log import LoggingConfig, get_logger
 
 
diff --git a/tests/test_edge_cases_pytest.py b/tests/test_edge_cases_pytest.py
@@ -1,9 +1,11 @@
 """Tests for edge cases in prismalog using pytest style."""
 
+import logging
 import os
+
 import pytest
-import logging
-from prismalog.log import ColoredLogger, ColoredFormatter, LoggingConfig, get_logger
+
+from prismalog.log import ColoredFormatter, ColoredLogger, LoggingConfig, get_logger
 
 
 @pytest.fixture
diff --git a/tests/test_fixtures.py b/tests/test_fixtures.py
@@ -3,8 +3,10 @@
 import logging
 import os
 from pathlib import Path
+
 import pytest
-from prismalog.log import LoggingConfig, CriticalExitHandler, get_logger, ColoredLogger
+
+from prismalog.log import ColoredLogger, CriticalExitHandler, LoggingConfig, get_logger
 
 
 def test_session_setup():
diff --git a/tests/test_log_format.py b/tests/test_log_format.py
@@ -8,14 +8,15 @@
 - Setting format via direct kwargs
 """
 
+import io
+import logging
 import os
 import re
-import tempfile
-import io
 import sys
-import logging
-from pathlib import Path
+import tempfile
 import time
+from pathlib import Path
+
 import pytest
 
 from prismalog.log import LoggingConfig, get_logger
diff --git a/tests/test_log_format_isolated.py b/tests/test_log_format_isolated.py
@@ -2,12 +2,14 @@
 import logging
 import os
 import sys
-import time
-import pytest
 import tempfile
+import time
 from pathlib import Path
 from unittest import TestCase
-from prismalog.log import LoggingConfig, get_logger, ColoredLogger
+
+import pytest
+
+from prismalog.log import ColoredLogger, LoggingConfig, get_logger
 
 
 @pytest.mark.usefixtures("tmp_path")
diff --git a/tests/test_prio.py b/tests/test_prio.py
@@ -8,10 +8,11 @@
 
 import os
 import tempfile
+
 import pytest
 
-from prismalog.log import LoggingConfig, get_logger
 from prismalog.argparser import extract_logging_args, get_argument_parser
+from prismalog.log import LoggingConfig, get_logger
 
 
 class TestConfigPriority:
@@ -98,6 +99,7 @@ def test_cli_args_override_yaml(self, yaml_config_file):
             "override_logs",  # Should override YAML's yaml_logs
             "--log-config",
             yaml_config_file,  # Load the YAML config too
+            "--exit-on-critical",  # Should override YAML's exit_on_critical
         ]
         args = parser.parse_args(cli_args)
         logging_args = extract_logging_args(args)
@@ -113,7 +115,7 @@ def test_cli_args_override_yaml(self, yaml_config_file):
         print(f"Log level: {level} (should be INFO, not ERROR)")
         print(f"Log dir: {log_dir} (should be override_logs, not yaml_logs)")
         print(f"Colored console: {colored} (should be False from YAML)")
-        print(f"Exit on critical: {exit_critical} (should be False from YAML)")
+        print(f"Exit on critical: {exit_critical} (should be True from CLI)")
 
         # CLI args should take precedence
         assert level == "INFO", f"Expected INFO level, got {level}"

Original file line number	Diff line number	Diff line change
`@@ -107,7 +107,7 @@ class LoggingConfig:`
`107`	`107`	`"log_format": "%(asctime)s - %(filename)s - %(name)s - [%(levelname)s] - %(message)s",`
`108`	`108`	`"colored_console": True,`
`109`	`109`	`"disable_rotation": False,`
`110`		`- "exit_on_critical": True, # Whether to exit the program on critical logs`
	`110`	`+ "exit_on_critical": False, # Whether to exit the program on critical logs`
`111`	`111`	`"test_mode": False, # Whether the logger is running in test mode`
`112`	`112`	`}`
`113`	`113`