Skip to content

Models

nautobot_data_validation_engine.models

Django models.

MinMaxValidationRule

Bases: ValidationRule

A type of validation rule that applies min/max constraints to a given numeric model field.

Source code in nautobot_data_validation_engine/models.py 
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
class MinMaxValidationRule(ValidationRule):
    """
    A type of validation rule that applies min/max constraints to a given numeric model field.
    """

    field = models.CharField(
        max_length=50,
    )
    min = models.FloatField(
        null=True, blank=True, help_text="When set, apply a minimum value contraint to the value of the model field."
    )
    max = models.FloatField(
        null=True, blank=True, help_text="When set, apply a maximum value contraint to the value of the model field."
    )

    csv_headers = ["name", "slug", "enabled", "content_type", "field", "min", "max", "error_message"]
    clone_fields = ["enabled", "content_type", "min", "max", "error_message"]

    class Meta:
        ordering = ("name",)
        unique_together = [["content_type", "field"]]

    def get_absolute_url(self):
        """
        Absolute url for the instance.
        """
        return reverse("plugins:nautobot_data_validation_engine:minmaxvalidationrule", args=[self.slug])

    def to_csv(self):
        """
        Return tuple representing the instance, which this used for CSV export.
        """
        return (
            self.name,
            self.slug,
            self.enabled,
            f"{self.content_type.app_label}.{self.content_type.model}",
            self.field,
            self.min,
            self.max,
            self.error_message,
        )

    def clean(self):
        """
        Ensure field is valid for the model and has not been blacklisted.
        """
        if self.field not in [f.name for f in self.content_type.model_class()._meta.get_fields()]:
            raise ValidationError(
                {
                    "field": f"Not a valid field for content type {self.content_type.app_label}.{self.content_type.model}."
                }
            )

        whitelisted_field_types = (
            models.DecimalField,
            models.FloatField,
            models.IntegerField,
        )

        blacklisted_field_types = (
            models.AutoField,
            models.BigAutoField,
        )

        model_field = self.content_type.model_class()._meta.get_field(self.field)

        if not isinstance(model_field, whitelisted_field_types) or (
            self.field.startswith("_") or not model_field.editable or isinstance(model_field, blacklisted_field_types)
        ):
            raise ValidationError({"field": "This field's type does not support min/max validation."})

        if self.min is None and self.max is None:
            raise ValidationError("At least a minimum or maximum value must be specified.")

        if self.min is not None and self.max is not None and self.min > self.max:
            raise ValidationError(
                {
                    "min": "Minimum value cannot be more than the maximum value.",
                    "max": "Maximum value cannot be less than the minimum value.",
                }
            )

clean()

Ensure field is valid for the model and has not been blacklisted.

Source code in nautobot_data_validation_engine/models.py 
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
def clean(self):
    """
    Ensure field is valid for the model and has not been blacklisted.
    """
    if self.field not in [f.name for f in self.content_type.model_class()._meta.get_fields()]:
        raise ValidationError(
            {
                "field": f"Not a valid field for content type {self.content_type.app_label}.{self.content_type.model}."
            }
        )

    whitelisted_field_types = (
        models.DecimalField,
        models.FloatField,
        models.IntegerField,
    )

    blacklisted_field_types = (
        models.AutoField,
        models.BigAutoField,
    )

    model_field = self.content_type.model_class()._meta.get_field(self.field)

    if not isinstance(model_field, whitelisted_field_types) or (
        self.field.startswith("_") or not model_field.editable or isinstance(model_field, blacklisted_field_types)
    ):
        raise ValidationError({"field": "This field's type does not support min/max validation."})

    if self.min is None and self.max is None:
        raise ValidationError("At least a minimum or maximum value must be specified.")

    if self.min is not None and self.max is not None and self.min > self.max:
        raise ValidationError(
            {
                "min": "Minimum value cannot be more than the maximum value.",
                "max": "Maximum value cannot be less than the minimum value.",
            }
        )

get_absolute_url()

Absolute url for the instance.

Source code in nautobot_data_validation_engine/models.py 
166
167
168
169
170
def get_absolute_url(self):
    """
    Absolute url for the instance.
    """
    return reverse("plugins:nautobot_data_validation_engine:minmaxvalidationrule", args=[self.slug])

to_csv()

Return tuple representing the instance, which this used for CSV export.

Source code in nautobot_data_validation_engine/models.py 
172
173
174
175
176
177
178
179
180
181
182
183
184
185
def to_csv(self):
    """
    Return tuple representing the instance, which this used for CSV export.
    """
    return (
        self.name,
        self.slug,
        self.enabled,
        f"{self.content_type.app_label}.{self.content_type.model}",
        self.field,
        self.min,
        self.max,
        self.error_message,
    )

RegularExpressionValidationRule

Bases: ValidationRule

A type of validation rule that applies a regular expression to a given model field.

Source code in nautobot_data_validation_engine/models.py 
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
class RegularExpressionValidationRule(ValidationRule):
    """
    A type of validation rule that applies a regular expression to a given model field.
    """

    field = models.CharField(
        max_length=50,
    )
    regular_expression = models.TextField(validators=[validate_regex])

    csv_headers = ["name", "slug", "enabled", "content_type", "field", "regular_expression", "error_message"]
    clone_fields = ["enabled", "content_type", "regular_expression", "error_message"]

    class Meta:
        ordering = ("name",)
        unique_together = [["content_type", "field"]]

    def get_absolute_url(self):
        """
        Absolute url for the instance.
        """
        return reverse("plugins:nautobot_data_validation_engine:regularexpressionvalidationrule", args=[self.slug])

    def to_csv(self):
        """
        Return tuple representing the instance, which this used for CSV export.
        """
        return (
            self.name,
            self.slug,
            self.enabled,
            f"{self.content_type.app_label}.{self.content_type.model}",
            self.field,
            self.regular_expression,
            self.error_message,
        )

    def clean(self):
        """
        Ensure field is valid for the model and has not been blacklisted.
        """
        if self.field not in [f.name for f in self.content_type.model_class()._meta.get_fields()]:
            raise ValidationError(
                {
                    "field": f"Not a valid field for content type {self.content_type.app_label}.{self.content_type.model}."
                }
            )

        blacklisted_field_types = (
            models.AutoField,
            models.BigAutoField,
            models.BooleanField,
            models.FileField,
            models.FilePathField,
            models.ForeignKey,
            models.ImageField,
            models.JSONField,
            models.Manager,
            models.ManyToManyField,
            models.NullBooleanField,
            models.OneToOneField,
            models.fields.related.RelatedField,
            models.SmallAutoField,
            models.UUIDField,
        )

        model_field = self.content_type.model_class()._meta.get_field(self.field)

        if self.field.startswith("_") or not model_field.editable or isinstance(model_field, blacklisted_field_types):
            raise ValidationError({"field": "This field's type does not support regular expression validation."})

clean()

Ensure field is valid for the model and has not been blacklisted.

Source code in nautobot_data_validation_engine/models.py 
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
def clean(self):
    """
    Ensure field is valid for the model and has not been blacklisted.
    """
    if self.field not in [f.name for f in self.content_type.model_class()._meta.get_fields()]:
        raise ValidationError(
            {
                "field": f"Not a valid field for content type {self.content_type.app_label}.{self.content_type.model}."
            }
        )

    blacklisted_field_types = (
        models.AutoField,
        models.BigAutoField,
        models.BooleanField,
        models.FileField,
        models.FilePathField,
        models.ForeignKey,
        models.ImageField,
        models.JSONField,
        models.Manager,
        models.ManyToManyField,
        models.NullBooleanField,
        models.OneToOneField,
        models.fields.related.RelatedField,
        models.SmallAutoField,
        models.UUIDField,
    )

    model_field = self.content_type.model_class()._meta.get_field(self.field)

    if self.field.startswith("_") or not model_field.editable or isinstance(model_field, blacklisted_field_types):
        raise ValidationError({"field": "This field's type does not support regular expression validation."})

get_absolute_url()

Absolute url for the instance.

Source code in nautobot_data_validation_engine/models.py 
89
90
91
92
93
def get_absolute_url(self):
    """
    Absolute url for the instance.
    """
    return reverse("plugins:nautobot_data_validation_engine:regularexpressionvalidationrule", args=[self.slug])

to_csv()

Return tuple representing the instance, which this used for CSV export.

Source code in nautobot_data_validation_engine/models.py 
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
def to_csv(self):
    """
    Return tuple representing the instance, which this used for CSV export.
    """
    return (
        self.name,
        self.slug,
        self.enabled,
        f"{self.content_type.app_label}.{self.content_type.model}",
        self.field,
        self.regular_expression,
        self.error_message,
    )

ValidationRule

Bases: BaseModel, ChangeLoggedModel

Base model for all validation engine rule models

Source code in nautobot_data_validation_engine/models.py 
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
class ValidationRule(BaseModel, ChangeLoggedModel):
    """
    Base model for all validation engine rule models
    """

    name = models.CharField(max_length=100, unique=True)
    slug = models.SlugField(max_length=100, unique=True)
    content_type = models.ForeignKey(
        to=ContentType, on_delete=models.CASCADE, limit_choices_to=FeatureQuery("custom_validators")
    )
    enabled = models.BooleanField(default=True)
    error_message = models.CharField(
        max_length=255, null=True, blank=True, help_text="Optional error message to display when validation fails."
    )

    objects = ValidationRuleManager.as_manager()

    class Meta:
        abstract = True

    def __str__(self):
        """
        Return a sane string representation of the instance.
        """
        return self.name

__str__()

Return a sane string representation of the instance.

Source code in nautobot_data_validation_engine/models.py 
65
66
67
68
69
def __str__(self):
    """
    Return a sane string representation of the instance.
    """
    return self.name

ValidationRuleManager

Bases: RestrictedQuerySet

Adds a helper method for getting all active instances for a given content type.

Source code in nautobot_data_validation_engine/models.py 
31
32
33
34
35
36
37
38
39
40
41
42
class ValidationRuleManager(RestrictedQuerySet):
    """
    Adds a helper method for getting all active instances for a given content type.
    """

    def get_for_model(self, content_type):
        """
        Given a content type string (<app_label>.<model>), return all instances that are enabled for that model.
        """
        app_label, model = content_type.split(".")

        return self.filter(enabled=True, content_type__app_label=app_label, content_type__model=model)

get_for_model(content_type)

Given a content type string (.), return all instances that are enabled for that model.

Source code in nautobot_data_validation_engine/models.py 
36
37
38
39
40
41
42
def get_for_model(self, content_type):
    """
    Given a content type string (<app_label>.<model>), return all instances that are enabled for that model.
    """
    app_label, model = content_type.split(".")

    return self.filter(enabled=True, content_type__app_label=app_label, content_type__model=model)

validate_regex(value)

Checks that the value is a valid regular expression.

Don't confuse this with RegexValidator, which uses a regex to validate a value.

Source code in nautobot_data_validation_engine/models.py 
19
20
21
22
23
24
25
26
27
28
def validate_regex(value):
    """
    Checks that the value is a valid regular expression.

    Don't confuse this with RegexValidator, which *uses* a regex to validate a value.
    """
    try:
        re.compile(value)
    except re.error:
        raise ValidationError(f"{value} is not a valid regular expression.")