Closes #13149: Wrap form field labels with gettext_lazy()

Co-authored-by: Jeremy Stretch <jstretch@netboxlabs.com>
2024-05-10 07:54:54 +00:00 · 2023-07-31 23:52:38 +07:00
parent 83bebc1bd2
commit b7a9649269
51 changed files with 1381 additions and 601 deletions
--- a/netbox/virtualization/forms/bulk_create.py
+++ b/netbox/virtualization/forms/bulk_create.py
@@ -1,5 +1,5 @@
 from django import forms
-from django.utils.translation import gettext as _
+from django.utils.translation import gettext_lazy as _

 from utilities.forms import BootstrapMixin, form_from_model
 from utilities.forms.fields import ExpandableNameField
--- a/netbox/virtualization/forms/bulk_edit.py
+++ b/netbox/virtualization/forms/bulk_edit.py
@@ -1,5 +1,5 @@
 from django import forms
-from django.utils.translation import gettext as _
+from django.utils.translation import gettext_lazy as _

 from dcim.choices import InterfaceModeChoices
 from dcim.constants import INTERFACE_MTU_MAX, INTERFACE_MTU_MIN
@@ -25,6 +25,7 @@ __all__ = (

 class ClusterTypeBulkEditForm(NetBoxModelBulkEditForm):
    description = forms.CharField(
+        label=_('Description'),
        max_length=200,
        required=False
    )
@@ -38,6 +39,7 @@ class ClusterTypeBulkEditForm(NetBoxModelBulkEditForm):

 class ClusterGroupBulkEditForm(NetBoxModelBulkEditForm):
    description = forms.CharField(
+        label=_('Description'),
        max_length=200,
        required=False
    )
@@ -51,31 +53,38 @@ class ClusterGroupBulkEditForm(NetBoxModelBulkEditForm):

 class ClusterBulkEditForm(NetBoxModelBulkEditForm):
    type = DynamicModelChoiceField(
+        label=_('Type'),
        queryset=ClusterType.objects.all(),
        required=False
    )
    group = DynamicModelChoiceField(
+        label=_('Group'),
        queryset=ClusterGroup.objects.all(),
        required=False
    )
    status = forms.ChoiceField(
+        label=_('Status'),
        choices=add_blank_choice(ClusterStatusChoices),
        required=False,
        initial=''
    )
    tenant = DynamicModelChoiceField(
+        label=_('Tenant'),
        queryset=Tenant.objects.all(),
        required=False
    )
    region = DynamicModelChoiceField(
+        label=_('Region'),
        queryset=Region.objects.all(),
        required=False,
    )
    site_group = DynamicModelChoiceField(
+        label=_('Site group'),
        queryset=SiteGroup.objects.all(),
        required=False,
    )
    site = DynamicModelChoiceField(
+        label=_('Site'),
        queryset=Site.objects.all(),
        required=False,
        query_params={
@@ -84,17 +93,16 @@ class ClusterBulkEditForm(NetBoxModelBulkEditForm):
        }
    )
    description = forms.CharField(
+        label=_('Site'),
        max_length=200,
        required=False
    )
-    comments = CommentField(
-        label=_('Comments')
-    )
+    comments = CommentField()

    model = Cluster
    fieldsets = (
        (None, ('type', 'group', 'status', 'tenant', 'description')),
-        ('Site', ('region', 'site_group', 'site')),
+        (_('Site'), ('region', 'site_group', 'site')),
    )
    nullable_fields = (
        'group', 'site', 'tenant', 'description', 'comments',
@@ -103,15 +111,18 @@ class ClusterBulkEditForm(NetBoxModelBulkEditForm):

 class VirtualMachineBulkEditForm(NetBoxModelBulkEditForm):
    status = forms.ChoiceField(
+        label=_('Status'),
        choices=add_blank_choice(VirtualMachineStatusChoices),
        required=False,
        initial='',
    )
    site = DynamicModelChoiceField(
+        label=_('Site'),
        queryset=Site.objects.all(),
        required=False
    )
    cluster = DynamicModelChoiceField(
+        label=_('Cluster'),
        queryset=Cluster.objects.all(),
        required=False,
        query_params={
@@ -119,6 +130,7 @@ class VirtualMachineBulkEditForm(NetBoxModelBulkEditForm):
        }
    )
    device = DynamicModelChoiceField(
+        label=_('Device'),
        queryset=Device.objects.all(),
        required=False,
        query_params={
@@ -126,6 +138,7 @@ class VirtualMachineBulkEditForm(NetBoxModelBulkEditForm):
        }
    )
    role = DynamicModelChoiceField(
+        label=_('Role'),
        queryset=DeviceRole.objects.filter(
            vm_role=True
        ),
@@ -135,10 +148,12 @@ class VirtualMachineBulkEditForm(NetBoxModelBulkEditForm):
        }
    )
    tenant = DynamicModelChoiceField(
+        label=_('Tenant'),
        queryset=Tenant.objects.all(),
        required=False
    )
    platform = DynamicModelChoiceField(
+        label=_('Platform'),
        queryset=Platform.objects.all(),
        required=False
    )
@@ -155,17 +170,16 @@ class VirtualMachineBulkEditForm(NetBoxModelBulkEditForm):
        label=_('Disk (GB)')
    )
    description = forms.CharField(
+        label=_('Description'),
        max_length=200,
        required=False
    )
-    comments = CommentField(
-        label=_('Comments')
-    )
+    comments = CommentField()

    model = VirtualMachine
    fieldsets = (
        (None, ('site', 'cluster', 'device', 'status', 'role', 'tenant', 'platform', 'description')),
-        ('Resources', ('vcpus', 'memory', 'disk'))
+        (_('Resources'), ('vcpus', 'memory', 'disk'))
    )
    nullable_fields = (
        'site', 'cluster', 'device', 'role', 'tenant', 'platform', 'vcpus', 'memory', 'disk', 'description', 'comments',
@@ -174,20 +188,24 @@ class VirtualMachineBulkEditForm(NetBoxModelBulkEditForm):

 class VMInterfaceBulkEditForm(NetBoxModelBulkEditForm):
    virtual_machine = forms.ModelChoiceField(
+        label=_('Virtual machine'),
        queryset=VirtualMachine.objects.all(),
        required=False,
        disabled=True,
        widget=forms.HiddenInput()
    )
    parent = DynamicModelChoiceField(
+        label=_('Parent'),
        queryset=VMInterface.objects.all(),
        required=False
    )
    bridge = DynamicModelChoiceField(
+        label=_('Bridge'),
        queryset=VMInterface.objects.all(),
        required=False
    )
    enabled = forms.NullBooleanField(
+        label=_('Enabled'),
        required=False,
        widget=BulkEditNullBooleanSelect()
    )
@@ -198,10 +216,12 @@ class VMInterfaceBulkEditForm(NetBoxModelBulkEditForm):
        label=_('MTU')
    )
    description = forms.CharField(
+        label=_('Description'),
        max_length=100,
        required=False
    )
    mode = forms.ChoiceField(
+        label=_('Mode'),
        choices=add_blank_choice(InterfaceModeChoices),
        required=False
    )
@@ -235,8 +255,8 @@ class VMInterfaceBulkEditForm(NetBoxModelBulkEditForm):
    model = VMInterface
    fieldsets = (
        (None, ('mtu', 'enabled', 'vrf', 'description')),
-        ('Related Interfaces', ('parent', 'bridge')),
-        ('802.1Q Switching', ('mode', 'vlan_group', 'untagged_vlan', 'tagged_vlans')),
+        (_('Related Interfaces'), ('parent', 'bridge')),
+        (_('802.1Q Switching'), ('mode', 'vlan_group', 'untagged_vlan', 'tagged_vlans')),
    )
    nullable_fields = (
        'parent', 'bridge', 'mtu', 'vrf', 'description',
--- a/netbox/virtualization/forms/bulk_import.py
+++ b/netbox/virtualization/forms/bulk_import.py
@@ -1,4 +1,4 @@
-from django.utils.translation import gettext as _
+from django.utils.translation import gettext_lazy as _

 from dcim.choices import InterfaceModeChoices
 from dcim.models import Device, DeviceRole, Platform, Site
@@ -36,27 +36,32 @@ class ClusterGroupImportForm(NetBoxModelImportForm):

 class ClusterImportForm(NetBoxModelImportForm):
    type = CSVModelChoiceField(
+        label=_('Type'),
        queryset=ClusterType.objects.all(),
        to_field_name='name',
        help_text=_('Type of cluster')
    )
    group = CSVModelChoiceField(
+        label=_('Group'),
        queryset=ClusterGroup.objects.all(),
        to_field_name='name',
        required=False,
        help_text=_('Assigned cluster group')
    )
    status = CSVChoiceField(
+        label=_('Status'),
        choices=ClusterStatusChoices,
        help_text=_('Operational status')
    )
    site = CSVModelChoiceField(
+        label=_('Site'),
        queryset=Site.objects.all(),
        to_field_name='name',
        required=False,
        help_text=_('Assigned site')
    )
    tenant = CSVModelChoiceField(
+        label=_('Tenant'),
        queryset=Tenant.objects.all(),
        to_field_name='name',
        required=False,
@@ -70,28 +75,33 @@ class ClusterImportForm(NetBoxModelImportForm):

 class VirtualMachineImportForm(NetBoxModelImportForm):
    status = CSVChoiceField(
+        label=_('Status'),
        choices=VirtualMachineStatusChoices,
        help_text=_('Operational status')
    )
    site = CSVModelChoiceField(
+        label=_('Site'),
        queryset=Site.objects.all(),
        to_field_name='name',
        required=False,
        help_text=_('Assigned site')
    )
    cluster = CSVModelChoiceField(
+        label=_('Cluster'),
        queryset=Cluster.objects.all(),
        to_field_name='name',
        required=False,
        help_text=_('Assigned cluster')
    )
    device = CSVModelChoiceField(
+        label=_('Device'),
        queryset=Device.objects.all(),
        to_field_name='name',
        required=False,
        help_text=_('Assigned device within cluster')
    )
    role = CSVModelChoiceField(
+        label=_('Role'),
        queryset=DeviceRole.objects.filter(
            vm_role=True
        ),
@@ -100,12 +110,14 @@ class VirtualMachineImportForm(NetBoxModelImportForm):
        help_text=_('Functional role')
    )
    tenant = CSVModelChoiceField(
+        label=_('Tenant'),
        queryset=Tenant.objects.all(),
        required=False,
        to_field_name='name',
        help_text=_('Assigned tenant')
    )
    platform = CSVModelChoiceField(
+        label=_('Platform'),
        queryset=Platform.objects.all(),
        required=False,
        to_field_name='name',
@@ -122,27 +134,32 @@ class VirtualMachineImportForm(NetBoxModelImportForm):

 class VMInterfaceImportForm(NetBoxModelImportForm):
    virtual_machine = CSVModelChoiceField(
+        label=_('Virtual machine'),
        queryset=VirtualMachine.objects.all(),
        to_field_name='name'
    )
    parent = CSVModelChoiceField(
+        label=_('Parent'),
        queryset=VMInterface.objects.all(),
        required=False,
        to_field_name='name',
        help_text=_('Parent interface')
    )
    bridge = CSVModelChoiceField(
+        label=_('Bridge'),
        queryset=VMInterface.objects.all(),
        required=False,
        to_field_name='name',
        help_text=_('Bridged interface')
    )
    mode = CSVChoiceField(
+        label=_('Mode'),
        choices=InterfaceModeChoices,
        required=False,
        help_text=_('IEEE 802.1Q operational mode (for L2 interfaces)')
    )
    vrf = CSVModelChoiceField(
+        label=_('VRF'),
        queryset=VRF.objects.all(),
        required=False,
        to_field_name='rd',
--- a/netbox/virtualization/forms/filtersets.py
+++ b/netbox/virtualization/forms/filtersets.py
@@ -1,5 +1,5 @@
 from django import forms
-from django.utils.translation import gettext as _
+from django.utils.translation import gettext_lazy as _

 from dcim.models import Device, DeviceRole, Platform, Region, Site, SiteGroup
 from extras.forms import LocalConfigContextFilterForm
@@ -30,7 +30,7 @@ class ClusterGroupFilterForm(ContactModelFilterForm, NetBoxModelFilterSetForm):
    tag = TagFilterField(model)
    fieldsets = (
        (None, ('q', 'filter_id', 'tag')),
-        ('Contacts', ('contact', 'contact_role', 'contact_group')),
+        (_('Contacts'), ('contact', 'contact_role', 'contact_group')),
    )


@@ -38,10 +38,10 @@ class ClusterFilterForm(TenancyFilterForm, ContactModelFilterForm, NetBoxModelFi
    model = Cluster
    fieldsets = (
        (None, ('q', 'filter_id', 'tag')),
-        ('Attributes', ('group_id', 'type_id', 'status')),
-        ('Location', ('region_id', 'site_group_id', 'site_id')),
-        ('Tenant', ('tenant_group_id', 'tenant_id')),
-        ('Contacts', ('contact', 'contact_role', 'contact_group')),
+        (_('Attributes'), ('group_id', 'type_id', 'status')),
+        (_('Location'), ('region_id', 'site_group_id', 'site_id')),
+        (_('Tenant'), ('tenant_group_id', 'tenant_id')),
+        (_('Contacts'), ('contact', 'contact_role', 'contact_group')),
    )
    type_id = DynamicModelMultipleChoiceField(
        queryset=ClusterType.objects.all(),
@@ -54,6 +54,7 @@ class ClusterFilterForm(TenancyFilterForm, ContactModelFilterForm, NetBoxModelFi
        label=_('Region')
    )
    status = forms.MultipleChoiceField(
+        label=_('Status'),
        choices=ClusterStatusChoices,
        required=False
    )
@@ -90,11 +91,11 @@ class VirtualMachineFilterForm(
    model = VirtualMachine
    fieldsets = (
        (None, ('q', 'filter_id', 'tag')),
-        ('Cluster', ('cluster_group_id', 'cluster_type_id', 'cluster_id', 'device_id')),
-        ('Location', ('region_id', 'site_group_id', 'site_id')),
-        ('Attributes', ('status', 'role_id', 'platform_id', 'mac_address', 'has_primary_ip', 'local_context_data')),
-        ('Tenant', ('tenant_group_id', 'tenant_id')),
-        ('Contacts', ('contact', 'contact_role', 'contact_group')),
+        (_('Cluster'), ('cluster_group_id', 'cluster_type_id', 'cluster_id', 'device_id')),
+        (_('Location'), ('region_id', 'site_group_id', 'site_id')),
+        (_('Attributes'), ('status', 'role_id', 'platform_id', 'mac_address', 'has_primary_ip', 'local_context_data')),
+        (_('Tenant'), ('tenant_group_id', 'tenant_id')),
+        (_('Contacts'), ('contact', 'contact_role', 'contact_group')),
    )
    cluster_group_id = DynamicModelMultipleChoiceField(
        queryset=ClusterGroup.objects.all(),
@@ -148,6 +149,7 @@ class VirtualMachineFilterForm(
        label=_('Role')
    )
    status = forms.MultipleChoiceField(
+        label=_('Status'),
        choices=VirtualMachineStatusChoices,
        required=False
    )
@@ -175,8 +177,8 @@ class VMInterfaceFilterForm(NetBoxModelFilterSetForm):
    model = VMInterface
    fieldsets = (
        (None, ('q', 'filter_id', 'tag')),
-        ('Virtual Machine', ('cluster_id', 'virtual_machine_id')),
-        ('Attributes', ('enabled', 'mac_address', 'vrf_id', 'l2vpn_id')),
+        (_('Virtual Machine'), ('cluster_id', 'virtual_machine_id')),
+        (_('Attributes'), ('enabled', 'mac_address', 'vrf_id', 'l2vpn_id')),
    )
    cluster_id = DynamicModelMultipleChoiceField(
        queryset=Cluster.objects.all(),
@@ -192,6 +194,7 @@ class VMInterfaceFilterForm(NetBoxModelFilterSetForm):
        label=_('Virtual machine')
    )
    enabled = forms.NullBooleanField(
+        label=_('Enabled'),
        required=False,
        widget=forms.Select(
            choices=BOOLEAN_WITH_BLANK_CHOICES
@@ -199,12 +202,12 @@ class VMInterfaceFilterForm(NetBoxModelFilterSetForm):
    )
    mac_address = forms.CharField(
        required=False,
-        label='MAC address'
+        label=_('MAC address')
    )
    vrf_id = DynamicModelMultipleChoiceField(
        queryset=VRF.objects.all(),
        required=False,
-        label='VRF'
+        label=_('VRF')
    )
    l2vpn_id = DynamicModelMultipleChoiceField(
        queryset=L2VPN.objects.all(),
--- a/netbox/virtualization/forms/model_forms.py
+++ b/netbox/virtualization/forms/model_forms.py
@@ -1,7 +1,7 @@
 from django import forms
 from django.contrib.contenttypes.models import ContentType
 from django.core.exceptions import ValidationError
-from django.utils.translation import gettext as _
+from django.utils.translation import gettext_lazy as _

 from dcim.forms.common import InterfaceCommonForm
 from dcim.models import Device, DeviceRole, Platform, Rack, Region, Site, SiteGroup
@@ -30,7 +30,7 @@ class ClusterTypeForm(NetBoxModelForm):
    slug = SlugField()

    fieldsets = (
-        ('Cluster Type', (
+        (_('Cluster Type'), (
            'name', 'slug', 'description', 'tags',
        )),
    )
@@ -46,7 +46,7 @@ class ClusterGroupForm(NetBoxModelForm):
    slug = SlugField()

    fieldsets = (
-        ('Cluster Group', (
+        (_('Cluster Group'), (
            'name', 'slug', 'description', 'tags',
        )),
    )
@@ -60,13 +60,16 @@ class ClusterGroupForm(NetBoxModelForm):

 class ClusterForm(TenancyForm, NetBoxModelForm):
    type = DynamicModelChoiceField(
+        label=_('Type'),
        queryset=ClusterType.objects.all()
    )
    group = DynamicModelChoiceField(
+        label=_('Group'),
        queryset=ClusterGroup.objects.all(),
        required=False
    )
    site = DynamicModelChoiceField(
+        label=_('Site'),
        queryset=Site.objects.all(),
        required=False,
        selector=True
@@ -74,8 +77,8 @@ class ClusterForm(TenancyForm, NetBoxModelForm):
    comments = CommentField()

    fieldsets = (
-        ('Cluster', ('name', 'type', 'group', 'site', 'status', 'description', 'tags')),
-        ('Tenancy', ('tenant_group', 'tenant')),
+        (_('Cluster'), ('name', 'type', 'group', 'site', 'status', 'description', 'tags')),
+        (_('Tenancy'), ('tenant_group', 'tenant')),
    )

    class Meta:
@@ -87,16 +90,19 @@ class ClusterForm(TenancyForm, NetBoxModelForm):

 class ClusterAddDevicesForm(BootstrapMixin, forms.Form):
    region = DynamicModelChoiceField(
+        label=_('Region'),
        queryset=Region.objects.all(),
        required=False,
        null_option='None'
    )
    site_group = DynamicModelChoiceField(
+        label=_('Site group'),
        queryset=SiteGroup.objects.all(),
        required=False,
        null_option='None'
    )
    site = DynamicModelChoiceField(
+        label=_('Site'),
        queryset=Site.objects.all(),
        required=False,
        query_params={
@@ -105,6 +111,7 @@ class ClusterAddDevicesForm(BootstrapMixin, forms.Form):
        }
    )
    rack = DynamicModelChoiceField(
+        label=_('Rack'),
        queryset=Rack.objects.all(),
        required=False,
        null_option='None',
@@ -113,6 +120,7 @@ class ClusterAddDevicesForm(BootstrapMixin, forms.Form):
        }
    )
    devices = DynamicModelMultipleChoiceField(
+        label=_('Devices'),
        queryset=Device.objects.all(),
        query_params={
            'site_id': '$site',
@@ -142,7 +150,7 @@ class ClusterAddDevicesForm(BootstrapMixin, forms.Form):
            for device in self.cleaned_data.get('devices', []):
                if device.site != self.cluster.site:
                    raise ValidationError({
-                        'devices': "{} belongs to a different site ({}) than the cluster ({})".format(
+                        'devices': _("{} belongs to a different site ({}) than the cluster ({})").format(
                            device, device.site, self.cluster.site
                        )
                    })
@@ -157,10 +165,12 @@ class ClusterRemoveDevicesForm(ConfirmationForm):

 class VirtualMachineForm(TenancyForm, NetBoxModelForm):
    site = DynamicModelChoiceField(
+        label=_('Site'),
        queryset=Site.objects.all(),
        required=False
    )
    cluster = DynamicModelChoiceField(
+        label=_('Cluster'),
        queryset=Cluster.objects.all(),
        required=False,
        selector=True,
@@ -169,6 +179,7 @@ class VirtualMachineForm(TenancyForm, NetBoxModelForm):
        }
    )
    device = DynamicModelChoiceField(
+        label=_('Device'),
        queryset=Device.objects.all(),
        required=False,
        query_params={
@@ -178,6 +189,7 @@ class VirtualMachineForm(TenancyForm, NetBoxModelForm):
        help_text=_("Optionally pin this VM to a specific host device within the cluster")
    )
    role = DynamicModelChoiceField(
+        label=_('Role'),
        queryset=DeviceRole.objects.all(),
        required=False,
        query_params={
@@ -185,6 +197,7 @@ class VirtualMachineForm(TenancyForm, NetBoxModelForm):
        }
    )
    platform = DynamicModelChoiceField(
+        label=_('Platform'),
        queryset=Platform.objects.all(),
        required=False
    )
@@ -195,12 +208,12 @@ class VirtualMachineForm(TenancyForm, NetBoxModelForm):
    comments = CommentField()

    fieldsets = (
-        ('Virtual Machine', ('name', 'role', 'status', 'description', 'tags')),
-        ('Site/Cluster', ('site', 'cluster', 'device')),
-        ('Tenancy', ('tenant_group', 'tenant')),
-        ('Management', ('platform', 'primary_ip4', 'primary_ip6')),
-        ('Resources', ('vcpus', 'memory', 'disk')),
-        ('Config Context', ('local_context_data',)),
+        (_('Virtual Machine'), ('name', 'role', 'status', 'description', 'tags')),
+        (_('Site/Cluster'), ('site', 'cluster', 'device')),
+        (_('Tenancy'), ('tenant_group', 'tenant')),
+        (_('Management'), ('platform', 'primary_ip4', 'primary_ip6')),
+        (_('Resources'), ('vcpus', 'memory', 'disk')),
+        (_('Config Context'), ('local_context_data',)),
    )

    class Meta:
@@ -253,6 +266,7 @@ class VirtualMachineForm(TenancyForm, NetBoxModelForm):

 class VMInterfaceForm(InterfaceCommonForm, NetBoxModelForm):
    virtual_machine = DynamicModelChoiceField(
+        label=_('Virtual machine'),
        queryset=VirtualMachine.objects.all(),
        selector=True
    )
@@ -302,11 +316,11 @@ class VMInterfaceForm(InterfaceCommonForm, NetBoxModelForm):
    )

    fieldsets = (
-        ('Interface', ('virtual_machine', 'name', 'description', 'tags')),
-        ('Addressing', ('vrf', 'mac_address')),
-        ('Operation', ('mtu', 'enabled')),
-        ('Related Interfaces', ('parent', 'bridge')),
-        ('802.1Q Switching', ('mode', 'vlan_group', 'untagged_vlan', 'tagged_vlans')),
+        (_('Interface'), ('virtual_machine', 'name', 'description', 'tags')),
+        (_('Addressing'), ('vrf', 'mac_address')),
+        (_('Operation'), ('mtu', 'enabled')),
+        (_('Related Interfaces'), ('parent', 'bridge')),
+        (_('802.1Q Switching'), ('mode', 'vlan_group', 'untagged_vlan', 'tagged_vlans')),
    )

    class Meta:
--- a/netbox/virtualization/forms/object_create.py
+++ b/netbox/virtualization/forms/object_create.py
@@ -1,3 +1,4 @@
+from django.utils.translation import gettext_lazy as _
 from utilities.forms.fields import ExpandableNameField
 from .model_forms import VMInterfaceForm

@@ -7,7 +8,9 @@ __all__ = (


 class VMInterfaceCreateForm(VMInterfaceForm):
-    name = ExpandableNameField()
+    name = ExpandableNameField(
+        label=_('Name'),
+    )
    replication_fields = ('name',)

    class Meta(VMInterfaceForm.Meta):