Merge pull request #8 from armurox/add-version-0.0.6

Add version 0.0.6

Author: armurox

.github/workflows/ci.yml

@@ -9,7 +9,7 @@ on:
 jobs:
   pytest:
     needs: [lint]
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     strategy:
       matrix:
         python-version: ['3.7', '3.8', '3.9', '3.10', '3.11', '3.12']
@@ -27,7 +27,7 @@ jobs:
       run: tox
 
   lint:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v2
       - name: Set up Python 3.10
@@ -45,7 +45,7 @@ jobs:
   testpypi-package:
     if: github.event_name == 'release' && github.event.release.prerelease == true
     needs: [pytest]
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v2
       - name: Set up Python 3.10
@@ -75,7 +75,7 @@ jobs:
   pypi-package:
     if: github.event_name == 'release' && github.event.release.prerelease == false
     needs: [pytest]
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v2
       - name: Set up Python 3.10

README.md

@@ -128,15 +128,20 @@ logging.config.dictConfig(LOGGING)
 The essence boils down to adding the RedactingFilter to your logging config, and to the filters section of the associated handlers to which you want to apply the redaction.
 
 
-## Release Notes - v0.0.5:
+## Release Notes - v0.0.6:
 
 ### Improvements and Changes
-- Optimized function that applies the redaction (was setting the logger message value twice).
-- Changed default_mask key initialization to mask
-- Changed patterns key initialization to mask_patterns
+- Allow redaction of any generic mapping type, including:
+    1. `dict`
+    2. `collections.OrderedDict`
+    3. `frozendict.frozendict`
+    4. `collections.ChainMap`
+    5. `types.MappingProxyType`
+    6. `collections.UserDict`
+and any other mapping class that inherits from `collections.Mapping`
 
 ### Bug Fixes
-- Handled any exceptions related to deepcopies failing, related to attempt to redact IOStreams, including TypeError
+- Fix bug that was converting non-string data types to strings. (Reported in issue [#7](https://github.com/armurox/loggingredactor/issues/7))
 
 
 ## A Note about the Motivation behind Logging Redactor:

loggingredactor/redacting_filter.py

@@ -1,6 +1,7 @@
 import re
 import logging
 import copy
+from collections.abc import Mapping
 
 
 class RedactingFilter(logging.Filter):
@@ -32,22 +33,23 @@ def redact(self, content, key=None):
         except Exception:
             return content
         if content_copy:
-            if isinstance(content_copy, dict):
-                for k, v in content_copy.items():
-                    content_copy[k] = self._mask if k in self._mask_keys else self.redact(v)
+            if isinstance(content_copy, Mapping):  # Covers all dict-like objects
+                content_copy = type(content_copy)([
+                    (k, self._mask if k in self._mask_keys else self.redact(v))
+                    for k, v in content_copy.items()
+                ])
 
             elif isinstance(content_copy, list):
                 content_copy = [self.redact(value) for value in content_copy]
 
-            elif isinstance(content, tuple):
+            elif isinstance(content_copy, tuple):
                 content_copy = tuple(self.redact(value) for value in content_copy)
 
             # Support for keys in extra field
             elif key and key in self._mask_keys:
                 content_copy = self._mask
 
-            else:
-                content_copy = isinstance(content_copy, str) and content_copy or str(content_copy)
+            elif isinstance(content_copy, str):
                 for pattern in self._mask_patterns:
                     content_copy = re.sub(pattern, self._mask, content_copy)
 

setup.py

@@ -11,7 +11,7 @@
 url = f"https://github.com/armurox/loggingredactor/tree/{branch}"
 
 # Get version from environment variable
-version = os.getenv('RELEASE_VERSION', '0.0.6')  # Default to '0.0.5' if RELEASE_VERSION is not set
+version = os.getenv('RELEASE_VERSION', '0.0.6')  # Default to '0.0.6' if RELEASE_VERSION is not set
 # Get development status
 split_version = version.split('-')
 if len(split_version) == 2:

tests/test_redacting_filter.py

@@ -2,6 +2,11 @@
 import pytest
 import logging
 import loggingredactor
+from frozendict import frozendict
+from collections import OrderedDict, UserDict, ChainMap
+from types import MappingProxyType
+
+MAPPING_TYPES = [dict, OrderedDict, UserDict, ChainMap, frozendict, MappingProxyType]
 
 
 @pytest.fixture
@@ -67,7 +72,7 @@ def test_arg_list_with_digits(caplog, logger_setup):
     logger = logger_setup([re.compile(r'\d{3}')])
     nums = [123, '4567']
     logger.warning("foo %s", nums)
-    assert caplog.records[0].message == "foo ['****', '****7']"
+    assert caplog.records[0].message == "foo [123, '****7']"
     assert nums == [123, '4567']
 
 
@@ -83,7 +88,7 @@ def test_arg_dict_with_digits(caplog, logger_setup):
     logger = logger_setup([re.compile(r'\d{3}')])
     bar = {'bar': 123}
     logger.warning("foo %s", bar)
-    assert caplog.records[0].message == "foo {'bar': '****'}"
+    assert caplog.records[0].message == "foo {'bar': 123}"
     assert bar == {'bar': 123}
 
 
@@ -147,15 +152,15 @@ def test_extra_int_value(caplog, logger_setup):
     logger = logger_setup([re.compile(r'\d{3}')])
     bar = {'bar': 123}
     logger.warning("foo", extra=bar)
-    assert caplog.records[0].bar == "****"
+    assert caplog.records[0].bar == 123
     assert bar == {'bar': 123}
 
 
 def test_extra_float_value(caplog, logger_setup):
     logger = logger_setup([re.compile(r'\d{3}')])
     bar = {'bar': 123.6}
     logger.warning("foo", extra=bar)
-    assert caplog.records[0].bar == "****.6"
+    assert caplog.records[0].bar == 123.6
     assert bar == {'bar': 123.6}
 
 
@@ -177,35 +182,62 @@ def test_extra_nested_dict(caplog, logger_setup):
 
 def test_extra_do_redact_key(caplog, logger_setup):
     logger = logger_setup([re.compile(r'\d{3}')])
-    extra_data = {'thing987': '123'}
-    logger.warning("foo", extra=extra_data)
-    assert caplog.records[0].thing987 == "****"
-    extra_data = {'thing987': '123'}
+    for mapping_type in MAPPING_TYPES:
+        extra_data = mapping_type({'thing987': '123'})
+        logger.warning("foo", extra=extra_data)
+        assert caplog.records[0].thing987 == "****"
+        assert extra_data == {'thing987': '123'}
+        assert isinstance(extra_data, mapping_type)
 
 
 def test_extra_do_not_redact_key(caplog, logger_setup):
     logger = logger_setup([re.compile(r'\d{3}')])
-    extra_data = {'thing987': 'foobar'}
-    logger.warning("foo", extra=extra_data)
-    assert caplog.records[0].thing987 == "foobar"
-    extra_data = {'thing987': 'foobar'}
+    for mapping_type in MAPPING_TYPES:
+        extra_data = mapping_type({'thing987': 'foobar'})
+        logger.warning("foo", extra=extra_data)
+        assert caplog.records[0].thing987 == "foobar"
+        assert extra_data == {'thing987': 'foobar'}
+        assert isinstance(extra_data, mapping_type)
 
 
 def test_extra_nested_dict_with_list(caplog, logger_setup):
     logger = logger_setup([re.compile(r'\d{3}')])
-    extra_data = {
-        'bar': {
-            'thing': ['one', '456'],
-        },
-    }
-    logger.warning("foo", extra=extra_data)
-    assert caplog.records[0].bar['thing'][0] == 'one'
-    assert caplog.records[0].bar['thing'][1] == '****'
-    assert extra_data == {
-        'bar': {
-            'thing': ['one', '456'],
-        },
-    }
+    for mapping_type in MAPPING_TYPES:
+        extra_data = mapping_type({
+            'bar': mapping_type({
+                'thing': ['one', '456'],
+            }),
+        })
+        logger.warning("foo", extra=extra_data)
+        assert caplog.records[0].bar['thing'][0] == 'one'
+        assert caplog.records[0].bar['thing'][1] == '****'
+        assert extra_data == {
+            'bar': {
+                'thing': ['one', '456'],
+            },
+        }
+        assert isinstance(extra_data, mapping_type)
+        assert isinstance(extra_data['bar'], mapping_type)
+
+
+def test_extra_nested_dict_with_tuple(caplog, logger_setup):
+    logger = logger_setup([re.compile(r'\d{3}')])
+    for mapping_type in MAPPING_TYPES:
+        extra_data = mapping_type({
+            'bar': mapping_type({
+                'thing': ('one', '456'),
+            }),
+        })
+        logger.warning("foo", extra=extra_data)
+        assert caplog.records[0].bar['thing'][0] == 'one'
+        assert caplog.records[0].bar['thing'][1] == '****'
+        assert extra_data == {
+            'bar': {
+                'thing': ('one', '456'),
+            },
+        }
+        assert isinstance(extra_data, mapping_type)
+        assert isinstance(extra_data['bar'], mapping_type)
 
 
 def test_match_group(caplog, logger_setup):

tox.ini

@@ -17,7 +17,10 @@ deps = ruff
 commands = ruff check .
 
 [testenv]
-deps = pytest-cov
+deps =
+    pytest-cov
+    frozendict
+    .
 commands = python -m pytest --cov=./loggingredactor
 
 [testenv:flake8]