mirror/netbox-community-netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2024-05-10 07:54:54 +00:00
Code Activity

Rename fail() kwarg from attr to field

Browse Source
This commit is contained in:
jeremystretch
2021-06-09 12:11:47 -04:00
parent c69ef95c6a
commit f81b3d4ed6
2 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/additional-features/custom-validation.md
View File

@ -41,7 +41,7 @@ from extras.validators import CustomValidator
class MyValidator(CustomValidator):
def validate(self, instance):
if instance.status == 'active' and not instance.description:
self.fail("Active sites must have a description set!", attr='status')
self.fail("Active sites must have a description set!", field='status')
```
The `fail()` method may optionally specify a field with which to associate the supplied error message. If specified, the error message will appear to the user as associated with this field. If omitted, the error message will not be associated with any field.

8
netbox/extras/validators.py
View File

@ -63,10 +63,10 @@ class CustomValidator:
"""
return
def fail(self, message, attr=None):
def fail(self, message, field=None):
"""
Raise a ValidationError exception. Associate the provided message with an attribute if specified.
Raise a ValidationError exception. Associate the provided message with a form/serializer field if specified.
"""
if attr is not None:
raise ValidationError({attr: message})
if field is not None:
raise ValidationError({field: message})
raise ValidationError(message)