Allow inheritance/composition when creating custom scripts #6512

New Issue

adam · 2025-12-29T19:41:48+01:00

adam commented

2025-12-29 19:41:48 +01:00

Originally created by @kkthxbye-code on GitHub (May 25, 2022).

Originally assigned to: @kkthxbye-code on GitHub.

NetBox version

v3.2.3

Feature type

Change to existing functionality

Proposed functionality

I would like to be able to do the following:

class BaseTestScript:
    test = BooleanVar(label="This is a test!")

    def shared_function(self):
        pass

class FancyTestScript(BaseTestScript, Script):
    class Meta:
        name = "Fancy testing"
        commit_default = True
   
    def run(self, data, commit):
        is_test = self.data['test']
        
        if is_test:
            self.log_success("test!")

class AwesomeTestScript(BaseTestScript, Script):
    class Meta:
        name = "Awesome testing"
        commit_default = True
   
    def run(self, data, commit):
        is_test = self.data['test']
        
        if is_test:
            self.log_failure("test!")

This currently doesn't work. The script is recognized, but none of the ScriptVars are present. The reason is here:

2e5a5f71ba/netbox/extras/scripts.py (L307-L311)

__dict__ only contains attributes of the class itself, without attributes inherited from base classes.

I propose changing the code to:

# Iterate all base classes looking for ScriptVariables
for base_class in inspect.getmro(cls):
    for name, attr in base_class.__dict__.items():
        if name not in vars and issubclass(attr.__class__, ScriptVariable):
            vars[name] = attr

It will search all base classes for subclasses of ScriptVariable. From quick testing it seemed to work great without breaking existing scripts. If accepted I will provide the implementation.

Use case

Managing a lot of scripts is tedious and duplication of code is hard to avoid. Allowing to define base classes which can be extended to provide scripts that have similar but different functionality would help in keeping stuff clean and maintainable.

Database changes

None

External dependencies

None

Originally created by @kkthxbye-code on GitHub (May 25, 2022). Originally assigned to: @kkthxbye-code on GitHub. ### NetBox version v3.2.3 ### Feature type Change to existing functionality ### Proposed functionality I would like to be able to do the following: ``` class BaseTestScript: test = BooleanVar(label="This is a test!") def shared_function(self): pass class FancyTestScript(BaseTestScript, Script): class Meta: name = "Fancy testing" commit_default = True def run(self, data, commit): is_test = self.data['test'] if is_test: self.log_success("test!") class AwesomeTestScript(BaseTestScript, Script): class Meta: name = "Awesome testing" commit_default = True def run(self, data, commit): is_test = self.data['test'] if is_test: self.log_failure("test!") ``` This currently doesn't work. The script is recognized, but none of the ScriptVars are present. The reason is here: https://github.com/netbox-community/netbox/blob/2e5a5f71ba4622b2989d892d4215e2aefe59b91c/netbox/extras/scripts.py#L307-L311 `__dict__` only contains attributes of the class itself, without attributes inherited from base classes. I propose changing the code to: ```python # Iterate all base classes looking for ScriptVariables for base_class in inspect.getmro(cls): for name, attr in base_class.__dict__.items(): if name not in vars and issubclass(attr.__class__, ScriptVariable): vars[name] = attr ``` It will search all base classes for subclasses of ScriptVariable. From quick testing it seemed to work great without breaking existing scripts. If accepted I will provide the implementation. ### Use case Managing a lot of scripts is tedious and duplication of code is hard to avoid. Allowing to define base classes which can be extended to provide scripts that have similar but different functionality would help in keeping stuff clean and maintainable. ### Database changes None ### External dependencies None

adam added the status: accepted type: feature labels 2025-12-29 19:41:48 +01:00

adam closed this issue

2025-12-29 19:41:48 +01:00

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

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

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#6512