Redact API Key in logs (#212)

* redact in logs

* refactor

Author: vvillait88

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "peopledatalabs"
-version = "6.1.1"
+version = "6.2.0"
 description = "Official Python client for the People Data Labs API"
 homepage = "https://www.peopledatalabs.com"
 repository = "https://github.com/peopledatalabs/peopledatalabs-python"

src/peopledatalabs/__init__.py

@@ -5,6 +5,6 @@
 from .main import PDLPY
 
 
-__version__ = "6.1.1"
+__version__ = "6.2.0"
 
 __all__ = ["PDLPY"]

src/peopledatalabs/requests.py

@@ -47,6 +47,18 @@ def __post_init__(self):
         self.params = self.validator(**self.params).dict(exclude_none=True)
         logger.debug("Request object params after validation: %s", self.params)
 
+    def _sanitize_params(self) -> dict:
+        """
+        Creates a copy of params with sensitive data redacted for logging.
+
+        Returns:
+            A sanitized copy of the parameters dictionary.
+        """
+        logger_params = self.params.copy()
+        if "api_key" in logger_params:
+            logger_params["api_key"] = "***"
+        return logger_params
+
     def get(self):
         """
         Executes a GET request from the specified API.
@@ -60,7 +72,7 @@ def get(self):
         logger.info(
             "Calling %s with params: %s",
             self.url,
-            json.dumps(self.params, indent=2),
+            json.dumps(self._sanitize_params(), indent=2),
         )
         return requests.get(
             self.url, params=self.params, headers=self.headers, timeout=None
@@ -79,7 +91,7 @@ def post(self):
         logger.info(
             "Calling %s with params: %s",
             self.url,
-            json.dumps(self.params, indent=2),
+            json.dumps(self._sanitize_params(), indent=2),
         )
         return requests.post(
             self.url, json=self.params, headers=self.headers, timeout=None

tests/client/test_client.py

@@ -19,7 +19,7 @@ def test_version():
     """
     Version check.
     """
-    assert __version__ == "6.1.1"
+    assert __version__ == "6.2.0"
 
 
 @pytest.mark.usefixtures("fake_api_key")