Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tj-django/django-extra-field-validation
Extends the Django model with required, conditional, and optional field validation.
https://github.com/tj-django/django-extra-field-validation
django django-application django-forms django-instance-validation django-model-validation django-model-validators django-validator django-validators field-validation python validation
Last synced: 2 days ago
JSON representation
Extends the Django model with required, conditional, and optional field validation.
- Host: GitHub
- URL: https://github.com/tj-django/django-extra-field-validation
- Owner: tj-django
- License: apache-2.0
- Created: 2018-05-18T21:30:09.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T16:25:59.000Z (3 months ago)
- Last Synced: 2024-10-30T06:24:09.368Z (3 months ago)
- Topics: django, django-application, django-forms, django-instance-validation, django-model-validation, django-model-validators, django-validator, django-validators, field-validation, python, validation
- Language: Python
- Homepage: https://tj-django.github.io/django-extra-field-validation/
- Size: 374 KB
- Stars: 26
- Watchers: 4
- Forks: 6
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE-APACHE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# django-extra-field-validation
   [](https://pepy.tech/project/django-extra-field-validation)
[](https://github.com/tj-django/django-extra-field-validation/actions/workflows/test.yml)
[](https://www.codacy.com/gh/tj-django/django-extra-field-validation/dashboard?utm_source=github.com\&utm_medium=referral\&utm_content=tj-django/django-extra-field-validation\&utm_campaign=Badge_Grade) [](https://www.codacy.com/gh/tj-django/django-extra-field-validation/dashboard?utm_source=github.com\&utm_medium=referral\&utm_content=tj-django/django-extra-field-validation\&utm_campaign=Badge_Coverage)
## Table of Contents
* [Background](#background)
* [Installation](#installation)
* [Usage](#usage)
* [Require all fields](#require-all-fields)
* [Require at least one field in a collection](#require-at-least-one-field-in-a-collection)
* [Optionally require at least one field in a collection](#optionally-require-at-least-one-field-in-a-collection)
* [Conditionally require all fields](#conditionally-require-all-fields)
* [Conditionally require at least one field in a collection](#conditionally-require-at-least-one-field-in-a-collection)
* [Model Attributes](#model-attributes)
* [License](#license)
* [TODO's](#todos)
## Background
This package aims to provide tools needed to define custom field validation logic which can be used independently or with
django forms, test cases, API implementation or any model operation that requires saving data to the database.
This can also be extended by defining check constraints if needed but currently validation
will only be handled at the model level.
## Installation
```shell script
pip install django-extra-field-validation
```
## Usage
### Require all fields
```py
from django.db import models
from extra_validator import FieldValidationMixin
class TestModel(FieldValidationMixin, models.Model):
amount = models.DecimalField(max_digits=5, decimal_places=2, null=True, blank=True)
fixed_price = models.DecimalField(max_digits=7, decimal_places=2, null=True, blank=True)
percentage = models.DecimalField(max_digits=3, decimal_places=0, null=True, blank=True)
REQUIRED_FIELDS = ['amount'] # Always requires an amount to create the instance.
```
Example
```python
In [1]: from decimal import Decimal
In [2]: from demo.models import TestModel
In [3]: TestModel.objects.create(fixed_price=Decimal('3.00'))
---------------------------------------------------------------------------
ValueError Traceback (most recent call last)
...
ValueError: {'amount': ValidationError([u'Please provide a value for: "amount".'])}
```
### Require at least one field in a collection
```py
from django.db import models
from extra_validator import FieldValidationMixin
class TestModel(FieldValidationMixin, models.Model):
amount = models.DecimalField(max_digits=5, decimal_places=2, null=True, blank=True)
fixed_price = models.DecimalField(max_digits=7, decimal_places=2, null=True, blank=True)
percentage = models.DecimalField(max_digits=3, decimal_places=0, null=True, blank=True)
REQUIRED_TOGGLE_FIELDS = [
['amount', 'fixed_price', 'percentage'], # Require only one of the following fields.
]
```
Example
```python
In [1]: from decimal import Decimal
In [2]: from demo.models import TestModel
In [3]: TestModel.objects.create(amount=Decimal('2.50'), fixed_price=Decimal('3.00'))
---------------------------------------------------------------------------
ValueError Traceback (most recent call last)
...
ValueError: {'fixed_price': ValidationError([u'Please provide only one of: Amount, Fixed price, Percentage'])}
```
### Optionally require at least one field in a collection
```py
from django.db import models
from extra_validator import FieldValidationMixin
class TestModel(FieldValidationMixin, models.Model):
amount = models.DecimalField(max_digits=5, decimal_places=2, null=True, blank=True)
fixed_price = models.DecimalField(max_digits=7, decimal_places=2, null=True, blank=True)
percentage = models.DecimalField(max_digits=3, decimal_places=0, null=True, blank=True)
OPTIONAL_TOGGLE_FIELDS = [
['fixed_price', 'percentage'] # Optionally validates that only fixed price/percentage are provided when present.
]
```
Example
```python
In [1]: from decimal import Decimal
In [2]: from demo.models import TestModel
In [3]: first_obj = TestModel.objects.create(amount=Decimal('2.0'))
In [4]: second_obj = TestModel.objects.create(amount=Decimal('2.0'), fixed_price=Decimal('3.00'))
In [5]: third_obj = TestModel.objects.create(amount=Decimal('2.0'), fixed_price=Decimal('3.00'), percentage=Decimal('10.0'))
---------------------------------------------------------------------------
ValueError Traceback (most recent call last)
...
ValueError: {'percentage': ValidationError([u'Please provide only one of: Fixed price, Percentage'])}
```
### Conditionally require all fields
```py
from django.db import models
from django.conf import settings
from extra_validator import FieldValidationMixin
class TestModel(FieldValidationMixin, models.Model):
user = models.ForeignKey(settings.AUTH_USER_MODEL)
amount = models.DecimalField(max_digits=5, decimal_places=2, null=True, blank=True)
fixed_price = models.DecimalField(max_digits=7, decimal_places=2, null=True, blank=True)
percentage = models.DecimalField(max_digits=3, decimal_places=0, null=True, blank=True)
CONDITIONAL_REQUIRED_FIELDS = [
(
lambda instance: instance.user.is_active, ['amount', 'percentage'],
),
]
```
Example
```python
In [1]: from decimal import Decimal
in [2]: from django.contrib.auth import get_user_model
In [3]: from demo.models import TestModel
In [4]: user = get_user_model().objects.create(username='test', is_active=True)
In [5]: first_obj = TestModel.objects.create(user=user, amount=Decimal('2.0'))
---------------------------------------------------------------------------
ValueError Traceback (most recent call last)
...
ValueError: {u'percentage': ValidationError([u'Please provide a value for: "percentage"'])}
```
### Conditionally require at least one field in a collection
```py
from django.db import models
from django.conf import settings
from extra_validator import FieldValidationMixin
class TestModel(FieldValidationMixin, models.Model):
user = models.ForeignKey(settings.AUTH_USER_MODEL)
amount = models.DecimalField(max_digits=5, decimal_places=2, null=True, blank=True)
fixed_price = models.DecimalField(max_digits=7, decimal_places=2, null=True, blank=True)
percentage = models.DecimalField(max_digits=3, decimal_places=0, null=True, blank=True)
CONDITIONAL_REQUIRED_TOGGLE_FIELDS = [
(
lambda instance: instance.user.is_active, ['fixed_price', 'percentage', 'amount'],
),
]
```
Example
```python
In [1]: from decimal import Decimal
in [2]: from django.contrib.auth import get_user_model
In [3]: from demo.models import TestModel
In [4]: user = get_user_model().objects.create(username='test', is_active=True)
In [5]: first_obj = TestModel.objects.create(user=user)
---------------------------------------------------------------------------
ValueError Traceback (most recent call last)
...
ValueError: {'__all__': ValidationError([u'Please provide a valid value for any of the following fields: Fixed price, Percentage, Amount'])}
In [6]: second_obj = TestModel.objects.create(user=user, amount=Decimal('2'), fixed_price=Decimal('2'))
---------------------------------------------------------------------------
ValueError Traceback (most recent call last)
...
ValueError: {'__all__': ValidationError([u'Please provide only one of the following fields: Fixed price, Percentage, Amount'])}
```
## Model Attributes
This is done using model attributes below.
```py
# A list of required fields
REQUIRED_FIELDS = []
# A list of fields with at most one required.
REQUIRED_TOGGLE_FIELDS = []
# A list of field with at least one required.
REQUIRED_MIN_FIELDS = []
# Optional list of fields with at most one required.
OPTIONAL_TOGGLE_FIELDS = []
# Conditional field required list of tuples the condition a boolean or a callable.
# [(lambda user: user.is_admin, ['first_name', 'last_name'])] : Both 'first_name' or 'last_name'
# If condition is True ensure that all fields are set
CONDITIONAL_REQUIRED_FIELDS = []
# [(lambda user: user.is_admin, ['first_name', 'last_name'])] : Either 'first_name' or 'last_name'
# If condition is True ensure that at most one field is set
CONDITIONAL_REQUIRED_TOGGLE_FIELDS = []
# [(lambda user: user.is_admin, ['first_name', 'last_name'])] : At least 'first_name' or 'last_name' provided or both
# If condition is True ensure that at least one field is set
CONDITIONAL_REQUIRED_MIN_FIELDS = []
# [(lambda user: user.is_admin, ['first_name', 'last_name'])] : Both 'first_name' and 'last_name' isn't provided
# If condition is True ensure none of the fields are provided
CONDITIONAL_REQUIRED_EMPTY_FIELDS = []
```
## License
django-extra-field-validation is distributed under the terms of both
* [MIT License](https://choosealicense.com/licenses/mit)
* [Apache License, Version 2.0](https://choosealicense.com/licenses/apache-2.0)
at your option.
## TODO's
* \[ ] Support `CONDITIONAL_NON_REQUIRED_TOGGLE_FIELDS`
* \[ ] Support `CONDITIONAL_NON_REQUIRED_FIELDS`
* \[ ] Move to support class and function based validators that use the instance object this should enable cross field model validation.