Inherit Script class

[rizlas]

Hi,
I'm currently trying to inherit Script class to create a CustomScript class that contains basic objects (inputs, functions, etc.) that I would like to reuse in other scripts. I've achieved what I needed but right now when I add a script the base class (CustomScript) is added as independent script for each script that inherit from CustomScript.

Example:

"""base.py."""
from extras.scripts import BooleanVar, Script


class CustomScript(Script):

    nice_flag = BooleanVar("Activate nice flag", default=False)

    def common_function(self):
        self.log_success("You're beautiful")

"""myscript.py"""
from scripts.base import CustomScript

class BestScript(CustomScript):
    def run(self, data, commit):
        self.common_function()

When i add myscript.py this is the result:

Any suggestion to avoid this behavior?

[candlerb]

Try using a Mixin instead of subclassing.

class CustomScriptMixin:
    ...

class BestScript(Script, CustomScriptMixin):
    ...

Plenty of examples of this in the Netbox core code - just search for the text Mixin. I'm not sure if nice_flag would be picked up this way though, and if not, you might need to use a subclassing hook.

[rizlas]

Seems to work, thank you! Final example:

"""base.py."""

from extras.scripts import BooleanVar


class CustomScriptMixin:

    class Meta:  # noqa: D106
        commit_default = False
        fieldsets = (
            (
                "Nice section",
                ("nice_flag",),
            ),
        )

    nice_flag = BooleanVar("Activate nice flag", default=False)

    def common_function(self):
        self.log_success("You're beautiful")

"""myscript.py"""

from extras.scripts import Script

from scripts.base_script import CustomScriptMixin


class BestScript(Script, CustomScriptMixin):
    def run(self, data, commit):
        self.common_function()

[dga-nagra]

You should make your mixin inherit from BaseScript.
Otherwise, your linter may complain that some functions like log_warning are not available.

NOTE: I expected BaseScript to be enough, but the child class still need to inherit Script as well..