feat: add a conf module that reads .env and environment variable overrides

Author: lpm0073

Makefile

@@ -1,10 +1,19 @@
+SHELL := /bin/bash
 PYTHON = python3
 PIP = $(PYTHON) -m pip
+
+ifneq ("$(wildcard .env)","")
+    include .env
+endif
+
 .PHONY: pre-commit requirements init clean report test build release-test release-prod help
 
 # Default target executed when no arguments are given to make.
 all: help
 
+analyze:
+	cloc . --exclude-ext=svg,json,zip --vcs=git
+
 init:
 	make clean && \
 	npm install && \

requirements/local.txt

@@ -16,3 +16,7 @@ bandit==1.7.5
 pydocstringformatter==0.7.3
 tox==4.11.4
 codespell==2.2.6
+
+# project dependencies
+# ------------
+python-decouple==3.8

secure_logger/conf.py

@@ -0,0 +1,43 @@
+# -*- coding: utf-8 -*-
+"""Module conf.py"""
+
+import logging
+
+from decouple import config
+
+from secure_logger.exceptions import ConfigurationError
+
+
+_DEFAULT_SENSITIVE_KEYS = [
+    "password",
+    "token",
+    "client_id",
+    "client_secret",
+    "Authorization",
+    "secret",
+    "access_key_id",
+    "secret_access_key",
+    "access-key-id",
+    "secret-access-key",
+    "aws_access_key_id",
+    "aws_secret_access_key",
+    "aws-access-key-id",
+    "aws-secret-access-key",
+]
+_DEFAULT_REDACTION_MESSAGE = "*** -- secure_logger() -- ***"
+_DEFAULT_INDENT = 4
+
+DEFAULT_SENSITIVE_KEYS = config("DEFAULT_SENSITIVE_KEYS", default=_DEFAULT_SENSITIVE_KEYS, cast=list)
+DEFAULT_REDACTION_MESSAGE = config("DEFAULT_REDACTION_MESSAGE", default=_DEFAULT_REDACTION_MESSAGE)
+DEFAULT_INDENT = config("DEFAULT_INDENT", default=_DEFAULT_INDENT, cast=int)
+
+if not isinstance(DEFAULT_SENSITIVE_KEYS, list):
+    raise ConfigurationError("DEFAULT_SENSITIVE_KEYS must be a list")
+if not isinstance(DEFAULT_REDACTION_MESSAGE, str):
+    raise ConfigurationError("DEFAULT_REDACTION_MESSAGE must be a string")
+if not isinstance(DEFAULT_INDENT, int):
+    raise ConfigurationError("DEFAULT_INDENT must be an integer")
+
+logging.debug("DEFAULT_SENSITIVE_KEYS: %s", DEFAULT_SENSITIVE_KEYS)
+logging.debug("DEFAULT_REDACTION_MESSAGE: %s", DEFAULT_REDACTION_MESSAGE)
+logging.debug("DEFAULT_INDENT: %s", DEFAULT_INDENT)

secure_logger/exceptions.py

@@ -0,0 +1,10 @@
+# -*- coding: utf-8 -*-
+"""Module exceptions.py"""
+
+
+class ConfigurationError(Exception):
+    """Exception raised for errors in the configuration."""
+
+    def __init__(self, message):
+        self.message = message
+        super().__init__(self.message)

secure_logger/masked_dict.py

@@ -5,26 +5,11 @@
 import json
 from unittest.mock import MagicMock
 
-
-# our stuff
-DEFAULT_SENSITIVE_KEYS = [
-    "password",
-    "token",
-    "client_id",
-    "client_secret",
-    "Authorization",
-    "secret",
-    "access_key_id",
-    "secret_access_key",
-    "access-key-id",
-    "secret-access-key",
-    "aws_access_key_id",
-    "aws_secret_access_key",
-    "aws-access-key-id",
-    "aws-secret-access-key",
-]
-DEFAULT_REDACTION_MESSAGE = "*** -- secure_logger() -- ***"
-DEFAULT_INDENT = 4
+from secure_logger.conf import (
+    DEFAULT_INDENT,
+    DEFAULT_REDACTION_MESSAGE,
+    DEFAULT_SENSITIVE_KEYS,
+)
 
 
 class _JSONEncoder(json.JSONEncoder):