leaf-common 1.2.44__tar.gz → 1.2.45__tar.gz

{leaf_common-1.2.44 → leaf_common-1.2.45}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: leaf-common
-Version: 1.2.44
+Version: 1.2.45
 Summary: LEAF team common code library
 Author-email: Dan Fink <Daniel.Fink@cognizant.com>
 License-Expression: Apache-2.0

leaf_common-1.2.44/leaf_common/logging/sensitive_logger.py → leaf_common-1.2.45/leaf_common/logging/conditional_logger.py

@@ -22,25 +22,20 @@ from logging import Logger
 from os import getenv
 
 
-class SensitiveLogger:
+class ConditionalLogger:
     """
-    Wraps a logger to mask sensitive information.
+    Wraps a logger to mask logged information conditionally based on an environment variable setting.
     Uses the same general Logger interface as the whole world already uses.
-
-    We assume that any information coming in to this logger is considered sensitive information.
-    Turning off senstive logging information can be done by setting the LEAF_LOG_SENSTIVE to "false".
-    By default this is turned on, allowing developers to see sensitive information.
-    Strongly consider turning this off for production deployments.
     """
 
-    def __init__(self, logger: Logger):
+    def __init__(self, logger: Logger, env_var: str):
         """
         Constructor.
 
         :param logger: The wrapped logger to redirect write() calls to.
         """
         self.logger: Logger = logger
-        self._should_log: bool = getenv('LEAF_LOG_SENSITIVE', 'true').lower() == 'true'
+        self._should_log: bool = getenv(env_var, "true").lower() == "true"
 
     def should_log(self) -> bool:
         """

leaf_common-1.2.45/leaf_common/logging/sensitive_logger.py

@@ -0,0 +1,43 @@
+
+# Copyright © 2019-2026 Cognizant Technology Solutions Corp, www.cognizant.com.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# END COPYRIGHT
+"""
+See class comment for details.
+"""
+
+from logging import Logger
+
+from leaf_common.logging.conditional_logger import ConditionalLogger
+
+
+class SensitiveLogger(ConditionalLogger):
+    """
+    Wraps a logger to mask sensitive information.
+    Uses the same general Logger interface as the whole world already uses.
+
+    We assume that any information coming in to this logger is considered sensitive information.
+    Turning off senstive logging information can be done by setting the LEAF_LOG_SENSTIVE to "false".
+    By default this is turned on, allowing developers to see sensitive information.
+    Strongly consider turning this off for production deployments.
+    """
+
+    def __init__(self, logger: Logger):
+        """
+        Constructor.
+
+        :param logger: The wrapped logger to redirect write() calls to.
+        """
+        super().__init__(logger, "LEAF_LOG_SENSITIVE")

{leaf_common-1.2.44 → leaf_common-1.2.45}/leaf_common.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: leaf-common
-Version: 1.2.44
+Version: 1.2.45
 Summary: LEAF team common code library
 Author-email: Dan Fink <Daniel.Fink@cognizant.com>
 License-Expression: Apache-2.0

{leaf_common-1.2.44 → leaf_common-1.2.45}/leaf_common.egg-info/SOURCES.txt

@@ -73,6 +73,7 @@ leaf_common/log_utils/__init__.py
 leaf_common/log_utils/message_type.py
 leaf_common/log_utils/structured_message.py
 leaf_common/logging/__init__.py
+leaf_common/logging/conditional_logger.py
 leaf_common/logging/example_logging_config.hocon
 leaf_common/logging/logging_setup.py
 leaf_common/logging/sensitive_logger.py