From 9a7c08adb279a78a3c6c24f32743e453720186b9 Mon Sep 17 00:00:00 2001 From: Julio-Oliveira-Encora Date: Fri, 14 Jun 2024 12:55:55 -0300 Subject: [PATCH] Addressed PR comment. The logs for Report class logs were changed to keep the compatibility with the documentation. --- docs/customization/custom-scripts.md | 2 +- docs/customization/reports.md | 4 +++- netbox/extras/reports.py | 20 ++++++++++---------- netbox/extras/scripts.py | 2 +- 4 files changed, 15 insertions(+), 13 deletions(-) diff --git a/docs/customization/custom-scripts.md b/docs/customization/custom-scripts.md index 870d20c2c..2a8f252aa 100644 --- a/docs/customization/custom-scripts.md +++ b/docs/customization/custom-scripts.md @@ -139,7 +139,7 @@ These two methods will load data in YAML or JSON format, respectively, from file The Script object provides a set of convenient functions for recording messages at different severity levels: * `log_debug(message, object=None)` -* `log_success(message=None, object=None)` +* `log_success(message, object=None)` * `log_info(message, object=None)` * `log_warning(message, object=None)` * `log_failure(message, object=None)` diff --git a/docs/customization/reports.md b/docs/customization/reports.md index d40db650f..6687fadd8 100644 --- a/docs/customization/reports.md +++ b/docs/customization/reports.md @@ -58,7 +58,9 @@ self.log_failure( If you want to increase the success counter without generating a log message, choose one of the following options: ```python -log_success(None, None) +log_success(message="Success message", obj=obj) +log_success("Success message", None) +log_success(None, obj) log_success("", None) log_sucess() ``` diff --git a/netbox/extras/reports.py b/netbox/extras/reports.py index a70447364..0df8816cd 100644 --- a/netbox/extras/reports.py +++ b/netbox/extras/reports.py @@ -17,18 +17,18 @@ class Report(BaseScript): def log(self, message): self._log(message, None, level=LogLevelChoices.LOG_DEFAULT) - def log_success(self, obj=None, message=None): - super().log_success(message, obj) + def log_success(self, message=None, obj=None): + self._log(message, obj, level=LogLevelChoices.LOG_SUCCESS) - def log_info(self, obj=None, message=None): - super().log_info(message, obj) + def log_info(self, message=None, obj=None): + self._log(message, obj, level=LogLevelChoices.LOG_INFO) - def log_warning(self, obj=None, message=None): - super().log_warning(message, obj) + def log_warning(self, message=None, obj=None): + self._log(message, obj, level=LogLevelChoices.LOG_WARNING) - def log_failure(self, obj=None, message=None): - super().log_failure(message, obj) + def log_failure(self, message=None, obj=None): + self._log(message, obj, level=LogLevelChoices.LOG_FAILURE) # Added in v4.0 to avoid confusion with the log_debug() method provided by BaseScript - def log_debug(self, obj=None, message=None): - super().log_debug(message, obj) + def log_debug(self, message=None, obj=None): + self._log(message, obj, level=LogLevelChoices.LOG_DEBUG) diff --git a/netbox/extras/scripts.py b/netbox/extras/scripts.py index 5204763e4..0e74c3f0d 100644 --- a/netbox/extras/scripts.py +++ b/netbox/extras/scripts.py @@ -510,7 +510,7 @@ class BaseScript: def log_debug(self, message, obj=None): self._log(message, obj, level=LogLevelChoices.LOG_DEBUG) - def log_success(self, message=None, obj=None): + def log_success(self, message, obj=None): self._log(message, obj, level=LogLevelChoices.LOG_SUCCESS) def log_info(self, message, obj=None):