Allow for easier overriding of custom scripts _log method #130

New Issue

MrUnknownDE · 2026-04-05T16:22:04+02:00

MrUnknownDE commented

2026-04-05 16:22:04 +02:00

Originally created by @mburggraf on 3/17/2026

NetBox version

v4.5.4

Feature type

Change to existing functionality

Proposed functionality

It's not really a request, but more like a proposal:
Change the function-signatures of the log-wrapper functions in netbox/extras/scripts.py, to take additional parameters, like:

    def log_debug(self, message=None, obj=None, *args, **kwargs):
        self._log(message, obj, level=LogLevelChoices.LOG_DEBUG, *args, **kwargs)

(for all the wrapper functions)

Use case

As the comment in the _log function states, it shouldn't be called directly, but instead only by using one of the wrapper functions.
In case the author of a custom scripts likes to extend the functionality of the log_* methods to take additional parameters (for example: self.log_info("text", lang="de_DE")), it's not only necessary to override the_log method, but also all of the wrappers, which needlessly bloats the script.
By changing the function signatures to take any number of additional argument, which are just transferred to the main function, an override for the main function is all it takes, without tampering with the functionality of the wrappers.

Additionally, by slightly modifying the _log function, to return the newly added dict-entry, the custom script author can easily extend the information in in:

self.messages.append(retval:={
 ⋮
return retval

could allow to access it in a possible override by entry = super()._log(message, obj, level).

Database changes

No change required.

External dependencies

No change required.

*Originally created by @mburggraf on 3/17/2026* ### NetBox version v4.5.4 ### Feature type Change to existing functionality ### Proposed functionality It's not really a request, but more like a proposal: Change the function-signatures of the log-wrapper functions in `netbox/extras/scripts.py`, to take additional parameters, like: ``` def log_debug(self, message=None, obj=None, *args, **kwargs): self._log(message, obj, level=LogLevelChoices.LOG_DEBUG, *args, **kwargs) ``` (for all the wrapper functions) ### Use case As the comment in the `_log` function states, it shouldn't be called directly, but instead only by using one of the wrapper functions. In case the author of a custom scripts likes to extend the functionality of the log_* methods to take additional parameters (for example: `self.log_info("text", lang="de_DE")`), it's not only necessary to override the`_log` method, but also all of the wrappers, which needlessly bloats the script. By changing the function signatures to take any number of additional argument, which are just transferred to the main function, an override for the main function is all it takes, without tampering with the functionality of the wrappers. _Additionally_, by slightly modifying the `_log` function, to return the newly added dict-entry, the custom script author can easily extend the information in in: ``` self.messages.append(retval:={ ⋮ return retval ``` could allow to access it in a possible override by `entry = super()._log(message, obj, level)`. ### Database changes No change required. ### External dependencies No change required.

MrUnknownDE closed this issue

2026-04-05 16:22:04 +02:00

Sign in to join this conversation.

Branches Tags

main

21455-sql-indexes-audit

21357-register-model-actions

feature

20924-plugin-ui-components

21766-improve-test-coverage-for-sortable-table-columns

21157-export-template-public-models

21025-pre-render-config-contexts

21364-swagger

feature-ip-prefix-link

20911-dropdown-3

fix_module_substitution

21160-filterset

20911-dropdown-2

20044-elevation-stuck-lightmode

7604-filter-modifiers-v3

20660-script-load

19724-graphql

14884-script

19720-macaddress-interface-generic-relation

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

No Label netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github/netbox#130