clean code

.pre-commit-config.yaml

@@ -17,7 +17,7 @@ repos:
     rev: v1.9.0
     hooks:
       - id: mypy
-        args: ['--ignore-missing-imports', '--strict']
+        args: ['--strict']
 
   - repo: https://github.com/pre-commit/mirrors-prettier
     rev: v4.0.0-alpha.8

examples/examples.py

@@ -3,8 +3,8 @@
 message = "🔒 <Data Secured> 🔒"
 secured = Secured('examples/config-secrets.yaml', secure=True, message=message)
 
-print(secured.config_secrets.name)
-print(secured.config_secrets["name"])
+print(secured.config_secrets.name) # type: ignore
+print(secured.config_secrets["name"]) # type: ignore
 
 ad = AttrDict(secure=True, message=message)
 ad['password'] = 'my_secret'

secured/attribute.py

@@ -4,7 +4,7 @@
 # A type variable that can be any type.
 T = TypeVar('T')
 
-class AttrDict(dict):
+class AttrDict(dict): # type: ignore
     """
     A dictionary subclass that allows attribute-style access and can optionally secure its leaf values.
 
@@ -23,7 +23,7 @@ class AttrDict(dict):
         '<Custom Secured>'
     """
 
-    def __init__(self, *args, secure: bool = False, message: str = "<Sensitive data secured>", **kwargs) -> None:
+    def __init__(self, *args, secure: bool = False, message: str = "<Sensitive data secured>", **kwargs) -> None: # type: ignore
         """
         Initialize the AttrDict with the same arguments as a normal dict, plus options to secure.
 
@@ -43,7 +43,7 @@ def _convert_dicts(self) -> None:
         for key, value in list(self.items()):
             self[key] = self._convert_value(value)
 
-    def _convert_value(self, value: Any) -> T | Secure:
+    def _convert_value(self, value: dict | str) -> 'AttrDict' | Secure | str: # type: ignore
         """
         Converts and possibly secures the value based on its type and the secure setting.
 
@@ -59,7 +59,7 @@ def _convert_value(self, value: Any) -> T | Secure:
             return Secure(value, self.message)
         return value
 
-    def __getattr__(self, item: str) -> T | Secure:
+    def __getattr__(self, item: str) -> 'AttrDict' | Secure:
         """
         Enables attribute-style access to dictionary keys.
 
@@ -73,7 +73,7 @@ def __getattr__(self, item: str) -> T | Secure:
             AttributeError: If the attribute does not exist.
         """
         if item in self:
-            return self[item]
+            return self[item] # type: ignore
         else:
             raise AttributeError(f"'{type(self).__name__}' object has no attribute '{item}'")
 

secured/log_manager.py

@@ -1,8 +1,22 @@
 import logging
 
-def setup_default_logger():
+def setup_default_logger() -> logging.Logger:
     """
-    Setup a default logger with basic configuration.
+    Sets up and returns a logger with a basic configuration.
+
+    This function configures a logger to output log messages to the console (standard output).
+    It sets the logger's level to INFO, meaning it will handle INFO and higher level messages (WARNING, ERROR, CRITICAL).
+    The log output format includes the time of the log entry, the logger's name, the log level, and the log message.
+
+    If a logger with handlers is already set up for the module, this function does not add another handler.
+
+    Returns:
+        logging.Logger: A logger instance configured with a console handler.
+
+    Example:
+        >>> logger = setup_default_logger()
+        >>> logger.info("This is an info message")
+        2023-01-01 12:00:00 - __main__ - INFO - This is an info message
     """
     logger = logging.getLogger(__name__)
     logger.setLevel(logging.INFO)

secured/secure.py

@@ -17,7 +17,7 @@ class Secure(str):
     '<Data Hidden>'
     """
 
-    def __new__(cls, original: str, message: str = "<Sensitive data secured>"):
+    def __new__(cls, original: str, message: str = "<Sensitive data secured>"): # type: ignore
         """
         Create a new Secure instance that appears as a custom message.
 

secured/secured.py

@@ -1,5 +1,5 @@
 import os
-import yaml
+import yaml # type: ignore
 from typing import List
 
 from .log_manager import setup_default_logger
@@ -8,7 +8,7 @@
 from .attribute import AttrDict
 
 class Secured:
-    def __init__(self, yaml_paths: str | List[str] = None, secure: bool = False,
+    def __init__(self, yaml_paths: str | List[str] = None, secure: bool = False, # type: ignore
                  as_attrdict: bool = True, message: str = "<Sensitive data secured>", logger=None):
         """
         Initialize a Secured object to manage YAML configuration securely.
@@ -54,7 +54,7 @@ def load_yaml(self, yaml_paths: str | List[str], secure: bool) -> None:
                 self.logger.error(f"Error parsing YAML file {path}: {e}")
                 continue
 
-    def create_config(self, data: dict, secure: bool) -> AttrDict | dict[str, Secure]:
+    def create_config(self, data: dict[str, dict], secure: bool) -> AttrDict | dict[str, Secure]:
         """
         Create a configuration from data loaded from a YAML file.
 

setup.py

@@ -1,11 +1,11 @@
-import tomlkit
-from setuptools import setup, find_packages
+import tomlkit # type: ignore
+from setuptools import setup, find_packages # type: ignore
 
 # Read and parse the pyproject.toml file
 with open("pyproject.toml", "r") as toml_file:
     pyproject = tomlkit.parse(toml_file.read())
 
-def convert_version(poetry_version):
+def convert_version(poetry_version): # type: ignore
     """ Convert Poetry version specifier to setuptools specifier. """
     if poetry_version.startswith('^'):
         version = poetry_version[1:]
@@ -16,7 +16,7 @@ def convert_version(poetry_version):
 
 # Extract dependencies and convert versions
 dependencies = [
-    f"{pkg}{convert_version(ver)}" for pkg, ver in pyproject['tool']['poetry']['dependencies'].items()
+    f"{pkg}{convert_version(ver)}" for pkg, ver in pyproject['tool']['poetry']['dependencies'].items() # type: ignore
     if pkg != "python"
 ]