Rename function.

Author: MarcoSteinacher

django/cohiva/tests/test_utils_strings.py

@@ -1,37 +1,37 @@
 from django.test import TestCase
 
-from cohiva.utils.strings import remove_secrets_from_uri
+from cohiva.utils.strings import sanitize_log_message
 
 
 class UtilsStringsTestCase(TestCase):
-    def test_remove_secrets_from_uri_no_uri(self):
+    def test_sanitize_log_message_no_uri(self):
         text = "Normal text without URI"
-        safe_text = remove_secrets_from_uri(text)
+        safe_text = sanitize_log_message(text)
         self.assertEqual(safe_text, text)
 
-    def test_remove_secrets_from_uri_no_password(self):
+    def test_sanitize_log_message_uri_without_password(self):
         text = "Normal text without URI but no password https://user@host/path?bla=1 more text"
-        safe_text = remove_secrets_from_uri(text)
+        safe_text = sanitize_log_message(text)
         self.assertEqual(safe_text, text)
 
-    def test_remove_secrets_from_uri_https(self):
-        safe_text = remove_secrets_from_uri("https://user:_SECRET_@host")
+    def test_sanitize_log_message_uri_https(self):
+        safe_text = sanitize_log_message("https://user:_SECRET_@host")
         self.assertEqual(safe_text, "https://user:******@host")
 
-    def test_remove_secrets_from_uri_https_with_text(self):
-        safe_text = remove_secrets_from_uri("Text https://user:_SECRET_@host more text")
+    def test_sanitize_log_message_uri_https_with_text(self):
+        safe_text = sanitize_log_message("Text https://user:_SECRET_@host more text")
         self.assertEqual(safe_text, "Text https://user:******@host more text")
 
-    def test_remove_secrets_from_uri_mysql(self):
-        safe_text = remove_secrets_from_uri("Text mysql://user:_SECRET_@host more text")
+    def test_sanitize_log_message_uri_mysql(self):
+        safe_text = sanitize_log_message("Text mysql://user:_SECRET_@host more text")
         self.assertEqual(safe_text, "Text mysql://user:******@host more text")
 
-    def test_remove_secrets_from_uri_multiple(self):
+    def test_sanitize_log_message_multiple_uris(self):
         text = (
             "Text https://user:_SECRET_@host more text "
             "mysql://user:_SECRET_@host/path/to/?query=1 more text"
         )
-        safe_text = remove_secrets_from_uri(text)
+        safe_text = sanitize_log_message(text)
         self.assertEqual(
             safe_text,
             (

django/cohiva/utils/strings.py

@@ -7,7 +7,11 @@ def pluralize(count, singular, plural):
     return f"{count} {plural}"
 
 
-def remove_secrets_from_uri(text: str):
+def sanitize_log_message(text: str):
+    return _sanitize_uris(text)
+
+
+def _sanitize_uris(text: str):
     pattern = (
         r"\b(?P<protocol>[a-zA-Z][a-zA-Z0-9+.-]*)://"
         r"(?P<username>[^:@/\s]+):(?P<password>[^@/\s]+)@"

django/finance/accounting/manager.py

@@ -3,7 +3,7 @@
 
 from django.conf import settings
 
-from cohiva.utils.strings import remove_secrets_from_uri
+from cohiva.utils.strings import sanitize_log_message
 from finance.accounting import CashctrlBook, DummyBook, GnucashBook
 
 logger = logging.getLogger("finance_accounting")
@@ -120,7 +120,7 @@ def __enter__(self) -> CashctrlBook | GnucashBook | DummyBook | None:
                 self.backend_obj = self.backend_class(self.backend_label, self.db_id)
                 return self.backend_obj
             except Exception as e:
-                error_msg = remove_secrets_from_uri(str(e))
+                error_msg = sanitize_log_message(str(e))
                 logger.error(
                     f"Couldn't initialize accounting backend {self.backend_class}: {error_msg}"
                 )