feat(models): Add internationalization support

Introduces internationalization (i18n) to AccessList models. Updates field
definitions to use `gettext_lazy` for translations and improves model class
field consistency. Includes minor corrections to docstrings and comments.

Author: pheus

netbox_acls/models/access_list_rules.py

@@ -2,10 +2,10 @@
 Define the django models for this plugin.
 """
 
-from django.apps import apps
 from django.contrib.postgres.fields import ArrayField
 from django.db import models
 from django.urls import reverse
+from django.utils.translation import gettext_lazy as _
 from netbox.models import NetBoxModel
 
 from ..choices import ACLProtocolChoices, ACLRuleActionChoices, ACLTypeChoices
@@ -21,48 +21,42 @@
 class ACLRule(NetBoxModel):
     """
     Abstract model for ACL Rules.
-    Inherrited by both ACLStandardRule and ACLExtendedRule.
+    Inherited by both ACLStandardRule and ACLExtendedRule.
     """
 
     access_list = models.ForeignKey(
-        on_delete=models.CASCADE,
         to=AccessList,
-        verbose_name="Access List",
+        on_delete=models.CASCADE,
         related_name="rules",
+        verbose_name=_("Access List"),
     )
     index = models.PositiveIntegerField()
     remark = models.CharField(
+        verbose_name=_("Remark"),
         max_length=500,
         blank=True,
     )
     description = models.CharField(
+        verbose_name=_("Description"),
         max_length=500,
         blank=True,
     )
     action = models.CharField(
-        choices=ACLRuleActionChoices,
+        verbose_name=_("Action"),
         max_length=30,
+        choices=ACLRuleActionChoices,
     )
     source_prefix = models.ForeignKey(
-        blank=True,
-        null=True,
+        to="ipam.prefix",
         on_delete=models.PROTECT,
         related_name="+",
-        to="ipam.Prefix",
-        verbose_name="Source Prefix",
+        verbose_name=_("Source Prefix"),
+        blank=True,
+        null=True,
     )
 
     clone_fields = ("access_list", "action", "source_prefix")
-
-    def __str__(self):
-        return f"{self.access_list}: Rule {self.index}"
-
-    def get_action_color(self):
-        return ACLRuleActionChoices.colors.get(self.action)
-
-    @classmethod
-    def get_prerequisite_models(cls):
-        return [apps.get_model("ipam.Prefix"), AccessList]
+    prerequisite_models = ("netbox_acls.AccessList",)
 
     class Meta:
         """
@@ -73,8 +67,24 @@ class Meta:
         """
 
         abstract = True
-        ordering = ["access_list", "index"]
-        unique_together = ["access_list", "index"]
+        ordering = ("access_list", "index")
+        unique_together = ("access_list", "index")
+
+    def __str__(self):
+        return f"{self.access_list}: Rule {self.index}"
+
+    def get_absolute_url(self):
+        """
+        The method is a Django convention; although not strictly required,
+        it conveniently returns the absolute URL for any particular object.
+        """
+        return reverse(
+            f"plugins:{self._meta.app_label}:{self._meta.model_name}",
+            args=[self.pk],
+        )
+
+    def get_action_color(self):
+        return ACLRuleActionChoices.colors.get(self.action)
 
 
 class ACLStandardRule(ACLRule):
@@ -83,24 +93,13 @@ class ACLStandardRule(ACLRule):
     """
 
     access_list = models.ForeignKey(
-        on_delete=models.CASCADE,
         to=AccessList,
-        verbose_name="Standard Access List",
-        limit_choices_to={"type": ACLTypeChoices.TYPE_STANDARD},
+        on_delete=models.CASCADE,
         related_name="aclstandardrules",
+        limit_choices_to={"type": ACLTypeChoices.TYPE_STANDARD},
+        verbose_name=_("Standard Access List"),
     )
 
-    def get_absolute_url(self):
-        """
-        The method is a Django convention; although not strictly required,
-        it conveniently returns the absolute URL for any particular object.
-        """
-        return reverse("plugins:netbox_acls:aclstandardrule", args=[self.pk])
-
-    @classmethod
-    def get_prerequisite_models(cls):
-        return [AccessList]
-
     class Meta(ACLRule.Meta):
         """
         Define the model properties adding to or overriding the inherited class:
@@ -109,62 +108,60 @@ class Meta(ACLRule.Meta):
           - verbose name plural (for displaying in the GUI)
         """
 
-        verbose_name = "ACL Standard Rule"
-        verbose_name_plural = "ACL Standard Rules"
+        verbose_name = _("ACL Standard Rule")
+        verbose_name_plural = _("ACL Standard Rules")
 
 
 class ACLExtendedRule(ACLRule):
     """
     Inherits ACLRule.
-    Add ACLExtendedRule specific fields: source_ports, desintation_prefix, destination_ports, and protocol
+    Add ACLExtendedRule specific fields: source_ports, destination_prefix, destination_ports, and protocol
     """
 
     access_list = models.ForeignKey(
-        on_delete=models.CASCADE,
         to=AccessList,
-        verbose_name="Extended Access List",
-        limit_choices_to={"type": "extended"},
+        on_delete=models.CASCADE,
         related_name="aclextendedrules",
+        limit_choices_to={"type": "extended"},
+        verbose_name=_("Extended Access List"),
     )
     source_ports = ArrayField(
         base_field=models.PositiveIntegerField(),
+        verbose_name=_("Source Ports"),
         blank=True,
         null=True,
-        verbose_name="Soure Ports",
     )
     destination_prefix = models.ForeignKey(
-        blank=True,
-        null=True,
+        to="ipam.prefix",
         on_delete=models.PROTECT,
         related_name="+",
-        to="ipam.Prefix",
-        verbose_name="Destination Prefix",
+        verbose_name=_("Destination Prefix"),
+        blank=True,
+        null=True,
     )
     destination_ports = ArrayField(
         base_field=models.PositiveIntegerField(),
+        verbose_name=_("Destination Ports"),
         blank=True,
         null=True,
-        verbose_name="Destination Ports",
     )
     protocol = models.CharField(
-        blank=True,
-        choices=ACLProtocolChoices,
+        verbose_name=_("Protocol"),
         max_length=30,
+        choices=ACLProtocolChoices,
+        blank=True,
     )
 
-    def get_absolute_url(self):
-        """
-        The method is a Django convention; although not strictly required,
-        it conveniently returns the absolute URL for any particular object.
-        """
-        return reverse("plugins:netbox_acls:aclextendedrule", args=[self.pk])
-
-    def get_protocol_color(self):
-        return ACLProtocolChoices.colors.get(self.protocol)
-
-    @classmethod
-    def get_prerequisite_models(cls):
-        return [apps.get_model("ipam.Prefix"), AccessList]
+    clone_fields = (
+        "access_list",
+        "action",
+        "source_prefix",
+        "source_ports",
+        "destination_prefix",
+        "destination_ports",
+        "protocol",
+    )
+    prerequisite_models = ("netbox_acls.AccessList",)
 
     class Meta(ACLRule.Meta):
         """
@@ -174,5 +171,8 @@ class Meta(ACLRule.Meta):
           - verbose name plural (for displaying in the GUI)
         """
 
-        verbose_name = "ACL Extended Rule"
-        verbose_name_plural = "ACL Extended Rules"
+        verbose_name = _("ACL Extended Rule")
+        verbose_name_plural = _("ACL Extended Rules")
+
+    def get_protocol_color(self):
+        return ACLProtocolChoices.colors.get(self.protocol)

netbox_acls/models/access_lists.py

@@ -4,11 +4,11 @@
 
 from dcim.models import Device, Interface, VirtualChassis
 from django.contrib.contenttypes.fields import GenericForeignKey, GenericRelation
-from django.contrib.contenttypes.models import ContentType
 from django.core.exceptions import ValidationError
 from django.core.validators import RegexValidator
 from django.db import models
 from django.urls import reverse
+from django.utils.translation import gettext_lazy as _
 from netbox.models import NetBoxModel
 from virtualization.models import VirtualMachine, VMInterface
 
@@ -23,53 +23,57 @@
 
 alphanumeric_plus = RegexValidator(
     r"^[a-zA-Z0-9-_]+$",
-    "Only alphanumeric, hyphens, and underscores characters are allowed.",
+    _("Only alphanumeric, hyphens, and underscores characters are allowed."),
 )
 
 
 class AccessList(NetBoxModel):
     """
-    Model defintion for Access Lists.
+    Model definition for Access Lists.
     """
 
     name = models.CharField(
+        verbose_name=_("Name"),
         max_length=500,
         validators=[alphanumeric_plus],
     )
     assigned_object_type = models.ForeignKey(
-        to=ContentType,
-        limit_choices_to=ACL_HOST_ASSIGNMENT_MODELS,
+        to="contenttypes.ContentType",
         on_delete=models.PROTECT,
+        related_name="+",
+        limit_choices_to=ACL_HOST_ASSIGNMENT_MODELS,
+        verbose_name=_("Assigned Object Type"),
     )
     assigned_object_id = models.PositiveBigIntegerField()
     assigned_object = GenericForeignKey(
         ct_field="assigned_object_type",
         fk_field="assigned_object_id",
     )
     type = models.CharField(
+        verbose_name=_("Type"),
         max_length=30,
         choices=ACLTypeChoices,
     )
     default_action = models.CharField(
-        default=ACLActionChoices.ACTION_DENY,
+        verbose_name=_("Default Action"),
         max_length=30,
+        default=ACLActionChoices.ACTION_DENY,
         choices=ACLActionChoices,
-        verbose_name="Default Action",
     )
     comments = models.TextField(
         blank=True,
     )
 
     clone_fields = (
-        "type",
         "default_action",
+        "type",
     )
 
     class Meta:
-        unique_together = ["assigned_object_type", "assigned_object_id", "name"]
-        ordering = ["assigned_object_type", "assigned_object_id", "name"]
-        verbose_name = "Access List"
-        verbose_name_plural = "Access Lists"
+        unique_together = ("assigned_object_type", "assigned_object_id", "name")
+        ordering = ("assigned_object_type", "assigned_object_id", "name")
+        verbose_name = _("Access List")
+        verbose_name_plural = _("Access Lists")
 
     def __str__(self):
         return self.name
@@ -90,25 +94,28 @@ def get_type_color(self):
 
 class ACLInterfaceAssignment(NetBoxModel):
     """
-    Model defintion for Access Lists associations with other Host interfaces:
+    Model definition for Access Lists associations with other Host interfaces:
       - VM interfaces
       - device interface
       - tbd on more
     """
 
     access_list = models.ForeignKey(
-        on_delete=models.CASCADE,
         to=AccessList,
-        verbose_name="Access List",
+        on_delete=models.CASCADE,
+        verbose_name=_("Access List"),
     )
     direction = models.CharField(
+        verbose_name=_("Direction"),
         max_length=30,
         choices=ACLAssignmentDirectionChoices,
     )
     assigned_object_type = models.ForeignKey(
-        to=ContentType,
-        limit_choices_to=ACL_INTERFACE_ASSIGNMENT_MODELS,
+        to="contenttypes.ContentType",
         on_delete=models.PROTECT,
+        related_name="+",
+        limit_choices_to=ACL_INTERFACE_ASSIGNMENT_MODELS,
+        verbose_name=_("Assigned Object Type"),
     )
     assigned_object_id = models.PositiveBigIntegerField()
     assigned_object = GenericForeignKey(
@@ -120,22 +127,23 @@ class ACLInterfaceAssignment(NetBoxModel):
     )
 
     clone_fields = ("access_list", "direction")
+    prerequisite_models = ("netbox_acls.AccessList",)
 
     class Meta:
-        unique_together = [
+        unique_together = (
             "assigned_object_type",
             "assigned_object_id",
             "access_list",
             "direction",
-        ]
-        ordering = [
+        )
+        ordering = (
             "assigned_object_type",
             "assigned_object_id",
             "access_list",
             "direction",
-        ]
-        verbose_name = "ACL Interface Assignment"
-        verbose_name_plural = "ACL Interface Assignments"
+        )
+        verbose_name = _("ACL Interface Assignment")
+        verbose_name_plural = _("ACL Interface Assignments")
 
     def get_absolute_url(self):
         """
@@ -158,15 +166,9 @@ def clean(self):
         # Check if the assigned interface's host is the same as the host assigned to the access list.
         if interface_host != self.access_list.assigned_object:
             raise ValidationError(
-                {
-                    "assigned_object": "The assigned object must be the same as the device assigned to it."
-                }
+                {"assigned_object": _("The assigned object must be the same as the device assigned to it.")}
             )
 
-    @classmethod
-    def get_prerequisite_models(cls):
-        return [AccessList]
-
     def get_direction_color(self):
         return ACLAssignmentDirectionChoices.colors.get(self.direction)