feat: add decorator parameter log_level

Author: lpm0073

Makefile

@@ -2,6 +2,12 @@ SHELL := /bin/bash
 PYTHON = python3
 PIP = $(PYTHON) -m pip
 
+ifeq ($(OS),Windows_NT)
+    ACTIVATE_VENV = venv\Scripts\activate
+else
+    ACTIVATE_VENV = source venv/bin/activate
+endif
+
 ifneq ("$(wildcard .env)","")
     include .env
 endif
@@ -18,7 +24,7 @@ init:
 	make clean && \
 	npm install && \
 	python3.11 -m venv venv && \
-	source venv/bin/activate && \
+	$(ACTIVATE_VENV) && \
 	pip install --upgrade pip && \
 	make requirements && \
 	pre-commit install

README.md

@@ -31,30 +31,33 @@ pip install secure-logger
 
 ### As a decorator
 
-``` python
+```python
 from secure_logger.decorators import secure_logger
+import logging
 
-class Foo(object):
+logging.getLogger(__name__)
+logging.basicConfig(level=logging.INFO)
 
-    @secure_logger()
+class Foo(object):
+    @secure_logger(log_level='INFO')
     def bar(self, dict_data, list_data):
         pass
 
 # call your method, passing some sensitive data
 dict_data = {
-    'not_a_sensitive_key': 'you-can-see-me',
-    'aws-access-key_id': conf.AWS_ACCESS_KEY_ID,
-    'aws-secret-access-key': conf.AWS_SECRET_ACCESS_KEY
+    "not_a_sensitive_key": "you-can-see-me",
+    "aws-access-key-id": "i-am-hidden",
+    "aws-secret-access-key": "so-am-i",
 }
-list_data = ['foo', 'bar']
+list_data = ["foo", "bar"]
 foo = Foo()
 foo.bar(dict_data=dict_data, list_data=list_data)
 ```
 
 Log output:
 
-``` log
-INFO:secure_logger: __main__.Foo().bar()  keyword args: {
+```console
+INFO:secure_logger: __main__.bar() ['<__main__.Foo object at 0x103474ac0>'] keyword args: {
     "dict_data": {
         "not_a_sensitive_key": "you-can-see-me",
         "aws-access-key-id": "*** -- secure_logger() -- ***",
@@ -64,7 +67,6 @@ INFO:secure_logger: __main__.Foo().bar()  keyword args: {
         "foo",
         "bar"
     ]
-}
 ```
 
 ### As library functions

secure_logger/conf.py

@@ -31,7 +31,7 @@
 ]
 _SECURE_LOGGER_REDACTION_MESSAGE = "*** -- secure_logger() -- ***"
 _SECURE_LOGGER_INDENT = 4
-_SECURE_LOGGER_LOG_LEVEL = "DEBUG"
+_SECURE_LOGGER_LOG_LEVEL = "INFO"
 
 # pylint: disable=protected-access
 _SECURE_LOGGER_LOG_LEVELS = [level for level in logging._nameToLevel if level != "NOTSET"]
@@ -40,6 +40,7 @@
 class Settings(BaseModel):
     """Settings for secure_logger"""
 
+    logger_name: str = Field(LOGGER_NAME)
     secure_logger_sensitive_keys: list = Field(_SECURE_LOGGER_SENSITIVE_KEYS, env="SECURE_LOGGER_SENSITIVE_KEYS")
     secure_logger_redaction_message: str = Field(
         _SECURE_LOGGER_REDACTION_MESSAGE, env="SECURE_LOGGER_REDACTION_MESSAGE"
@@ -69,6 +70,17 @@ def logger(self):
         }
         return log_levels.get(self.secure_logger_logging_level, logging.debug)
 
+    def get_logger(self, log_level):
+        """Returns the logger function for the specified logging level"""
+        log_levels = {
+            "DEBUG": _logger.debug,
+            "INFO": _logger.info,
+            "WARNING": _logger.warning,
+            "ERROR": _logger.error,
+            "CRITICAL": _logger.critical,
+        }
+        return log_levels.get(log_level, logging.debug)
+
     @property
     def logger_level(self) -> int:
         """Returns the logger level for the specified logging level"""

secure_logger/decorators.py

@@ -9,11 +9,8 @@
 from secure_logger.masked_dict import masked_dict2str
 
 
-# module initializations
-logger = settings.logger
-
-
 def secure_logger(
+    log_level: str = settings.secure_logger_logging_level,
     sensitive_keys: list = settings.secure_logger_sensitive_keys,
     indent: int = settings.secure_logger_indent,
     message: str = settings.secure_logger_redaction_message,
@@ -64,13 +61,18 @@ def wrapper(*args, **kwargs):
             name_spec = name_of_module + "." if name_of_module else ""
             name_spec += name_of_class + "." if name_of_class else ""
             name_spec += name_of_def + "()" if name_of_def else ""
-
             if len(kwargs.keys()) > 0:
                 kwargs_dict_repr = "keyword args: "
                 kwargs_dict_repr += masked_dict2str(
                     kwargs, sensitive_keys=sensitive_keys, indent=indent, message=message
                 )
 
+            if log_level == settings.secure_logger_logging_level:
+                logger = settings.logger
+            else:
+                logger = settings.get_logger(log_level)
+
+            print(logger.__name__)
             logger(
                 "secure_logger: %s %s %s",
                 name_spec,

secure_logger/tests/tests.py

@@ -110,7 +110,7 @@ def test_decorator_output(self):
             settings.secure_logger_logging_level + ":decorator_logger:secure_logger: tests.mock_decorated_def() "
             "['<tests.TestModuleDefDecorator testMethod=test_decorator_output>', " + hello_world
         )
-        with self.assertLogs(level=settings.logger_level) as cm:
+        with self.assertLogs(logger=settings.logger_name, level=settings.logger_level) as cm:
             self.mock_decorated_def("hello world")
 
         self.assertEqual(cm.output[0][0:100], expected_output[0:100])
@@ -126,7 +126,12 @@ class MockClass:
         def decorator_with_defaults(self, test_dict, test_list):
             """Test class input parameter as objects."""
 
-        @secure_logger(sensitive_keys=["aws_secret_access_key"], indent=10, message="-- Forbidden! --")
+        @secure_logger(
+            log_level="INFO",
+            sensitive_keys=["aws_secret_access_key"],
+            indent=10,
+            message="-- Forbidden! --",
+        )
         def decorator_with_custom_params(self, test_dict, test_list):
             """Test class input parameter as objects."""
 
@@ -145,11 +150,22 @@ def test_class_method_with_default_params(self):
             "['<tests.TestClassMethodDecorator.MockClass"
         )
 
-        with self.assertLogs(level=settings.logger_level) as cm:
+        with self.assertLogs(logger=settings.logger_name, level=settings.logger_level) as cm:
             self.mock_class.decorator_with_defaults(self.test_dict, self.test_list)
 
         self.assertEqual(cm.output[0][0:100], expected_output[0:100])
 
+    def test_class_method_with_custom_params(self):
+        """Test class method with default parameters."""
+        expected_output = (
+            "INFO:decorator_logger:secure_logger: tests.decorator_with_custom_params() "
+            "['<tests.TestClassMethodDecorator.MockClass"
+        )
+        with self.assertLogs(logger=settings.logger_name) as cm:
+            self.mock_class.decorator_with_custom_params(self.test_dict, self.test_list)
+
+        self.assertEqual(cm.output[0][0:100], expected_output[0:100])
+
 
 class TestClassDecorator(unittest.TestCase):
     """Test class logging."""