NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-08-09 09:08:15 -06:00
Code Issues Actions 9 Packages Projects Releases Wiki Activity

Addressed PR comment.

Browse Source 
The logs for Report class logs were changed to keep the compatibility with the documentation.
This commit is contained in:
Julio-Oliveira-Encora 2024-06-14 12:55:55 -03:00
parent fe99ef81da
commit 9a7c08adb2
4 changed files with 15 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/customization/custom-scripts.md
View File

@ -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)`

4
docs/customization/reports.md
View File

@ -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()
```

20
netbox/extras/reports.py
View File

@ -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)

2
netbox/extras/scripts.py
View File

@ -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):