Release 2.4.0

nornir_nautobot/utils/logger.py

@@ -2,11 +2,13 @@
 
 import logging
 
+from typing import Any
+
 
 class NornirLogger:
     """Similar to a mixin, to utilize Python logging and Jobs Result obj."""
 
-    def __init__(self, name, nautobot_job=None, debug=False, job_result=None):
+    def __init__(self, name: str, nautobot_job=None, debug: bool = False, job_result=None):
         """Initialize the object."""
         self.job_result = job_result or nautobot_job
         self.logger = logging.getLogger(name)
@@ -19,31 +21,31 @@ def __init__(self, name, nautobot_job=None, debug=False, job_result=None):
             self.logger.warning(log_message)
             job_result.log_warning(log_message)
 
-    def log_debug(self, message):
+    def log_debug(self, message: str):
         """Debug, does not take obj, and only logs to jobs result when in global debug mode."""
         if self.nautobot_job and self.debug:
             self.nautobot_job.log_debug(message)
         self.logger.debug(message)
 
-    def log_info(self, obj, message):
+    def log_info(self, obj: Any, message: str):
         """Log to Python logger and jogs results for info messages."""
         if self.nautobot_job:
             self.nautobot_job.log_info(obj, message)
         self.logger.info("%s | %s", str(obj), message)
 
-    def log_success(self, obj, message):
+    def log_success(self, obj: Any, message: str):
         """Log to Python logger and jogs results for success messages."""
         if self.nautobot_job:
             self.nautobot_job.log_success(obj, message)
         self.logger.info("%s | %s", str(obj), message)
 
-    def log_warning(self, obj, message):
+    def log_warning(self, obj: Any, message: str):
         """Log to Python logger and jogs results for warning messages."""
         if self.nautobot_job:
             self.nautobot_job.log_warning(obj, message)
         self.logger.warning("%s | %s", str(obj), message)
 
-    def log_failure(self, obj, message):
+    def log_failure(self, obj: Any, message: str):
         """Log to Python logger and jogs results for failure messages."""
         if self.nautobot_job:
             self.nautobot_job.log_failure(obj, message)