Create DecimalVar class for custom script input

[kyerlasswell]

NetBox version

v4.2.9

Feature type

Data model extension

Proposed functionality

Create a new class in netbox/extras/scripts.py called DecimalVar that enables custom scripts to take in decimal numbers as user input. This would be functionally identical to IntegerVar except it would allow decimal numbers.

class DecimalVar(ScriptVariable):
    """
    Decimal representation. Can enforce minimum/maximum values.
    """

    form_field = forms.DecimalField

    def __init__(self, min_value=None, max_value=None, *args, **kwargs):
        super().__init__(*args, **kwargs)

        # Optional minimum/maximum values
        if min_value:
            self.field_attrs["min_value"] = min_value
        if max_value:
            self.field_attrs["max_value"] = max_value

Use case

There is currently no built-in way to get decimal input from a user in a custom script (unless I'm just overlooking something obvious). IntegerVar exists for whole number input, but it cannot be used to get, for example, GPS coordinates from a user trying to create a site from a custom script.

Adding DecimalVar would enable the following:

# get data from user:

site_lat = DecimalVar(
    label="Latitude",
)

site_long = DecimalVar(
    label="Longitude",
)

# run:
site = Site(
    name="name",
    slug="slug",
    region="region",
    latitude=data["site_lat"],
    longitude=data["site_long"],
)

Database changes

None

External dependencies

None

[sleepinggenius2]

As a workaround, we are currently doing this:

    latitude = StringVar(
        label="Latitude",
        regex=r"^-?(90|([1-8]?\d))(\.\d{1,6})?$",
    )

    longitude = StringVar(
        label="Longitude",
        regex=r"^-?(180|(1[0-7]|[1-9])?\d)(\.\d{1,6})?$",
    )

    def run(self, data, commit):
        site = Site(
            ...
            latitude=Decimal(data['latitude']),
            longitude=Decimal(data['longitude']),
        )

[kyerlasswell]

@sleepinggenius2 I started with something like that, but I ended up putting that DecimalVar class (that I just copied and modified from IntegerVar) directly into my custom script. This way, it can be used just like any other available variable class, you just have to import these:

• from django import forms
• from extras.scripts import ScriptVariable

So the whole script would look like:

from django import forms
from extras.scripts import ScriptVariable
from dcim.models import Site

class DecimalVar(ScriptVariable):
    """
    Decimal representation. Can enforce minimum/maximum values.
    """

    form_field = forms.DecimalField

    def __init__(self, min_value=None, max_value=None, *args, **kwargs):
        super().__init__(*args, **kwargs)

        # Optional minimum/maximum values
        if min_value:
            self.field_attrs["min_value"] = min_value
        if max_value:
            self.field_attrs["max_value"] = max_value

class ProvisionSite(Script):
    class Meta:
        name = "Provision site"

    site_lat = DecimalVar(
        label="Latitude",
    )

    site_long = DecimalVar(
        label="Longitude",
    )

    def run(self, data, commit):
        site = Site(
            ...
            latitude=data["site_lat"],
            longitude=data["site_long"],
        )

[sleepinggenius2]

If you're going to go that route, I would suggest adding options for max_digits and decimal_places to your constructor, as your current solution does not account for the max_digits=8, decimal_places=6 on the Site.latitude field and the max_digits=9, decimal_places=6 on the Site.longitude field.

[jnovinger]

Is this something you'd like to work on @kyerlasswell , given your start above?

[kyerlasswell]

Yeah I'd be happy to.

[jnovinger]

Thank @kyerlasswell ! It's all yours.