Skip to content

validators#

RequiredFieldCombinationValidatorBase#

Source code in src/apps/common/serializers/validators.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
class RequiredFieldCombinationValidatorBase:
    def __init__(self, fields, count_all_falsy=False):
        self.fields = set(fields)
        self.count_all_falsy = count_all_falsy

    @property
    def msg_fields(self):
        return ", ".join(f"'{f}'" for f in sorted(self.fields))

    def field_value_count(self, value):
        """Count how many non-empty field values exist."""
        if self.count_all_falsy:
            return sum(1 for key, v in value.items() if key in self.fields and v)
        else:  # count only empty values
            return sum(v not in EMPTY_VALUES for key, v in value.items() if key in self.fields)

field_value_count(value) #

Count how many non-empty field values exist.

Source code in src/apps/common/serializers/validators.py 
15
16
17
18
19
20
def field_value_count(self, value):
    """Count how many non-empty field values exist."""
    if self.count_all_falsy:
        return sum(1 for key, v in value.items() if key in self.fields and v)
    else:  # count only empty values
        return sum(v not in EMPTY_VALUES for key, v in value.items() if key in self.fields)

AnyOf#

Bases: RequiredFieldCombinationValidatorBase

Require at least one of fields to be non-empty.

Source code in src/apps/common/serializers/validators.py 
23
24
25
26
27
28
29
class AnyOf(RequiredFieldCombinationValidatorBase):
    """Require at least one of fields to be non-empty."""

    def __call__(self, value):
        if self.field_value_count(value) == 0:
            message = _("At least one of fields {} is required.").format(self.msg_fields)
            raise serializers.ValidationError(message)

OneOf#

Bases: RequiredFieldCombinationValidatorBase

Require exactly one of fields to be non-empty.

Source code in src/apps/common/serializers/validators.py 
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
class OneOf(RequiredFieldCombinationValidatorBase):
    """Require exactly one of fields to be non-empty."""

    def __init__(self, fields, required=False, count_all_falsy=False):
        self.required = required
        super().__init__(fields, count_all_falsy=count_all_falsy)

    def __call__(self, value):
        count = self.field_value_count(value)
        if count == 0 and not self.required:
            return
        if count != 1:
            if self.required:
                message = _("Exactly one of fields {} is required.").format(self.msg_fields)
            else:  # allow 0 or 1
                message = _("Only one of fields {} is allowed.").format(self.msg_fields)
            raise serializers.ValidationError(message)

AllOf#

Bases: RequiredFieldCombinationValidatorBase

Require all of listed fields.

Source code in src/apps/common/serializers/validators.py 
51
52
53
54
55
56
57
58
59
60
61
62
63
64
class AllOf(RequiredFieldCombinationValidatorBase):
    """Require all of listed fields."""

    def __call__(self, value):
        errors = {}
        for field in self.fields:
            if self.count_all_falsy:
                if not value.get(field):
                    errors[field] = _("Field is required.")
            else:
                if value.get(field) in EMPTY_VALUES:
                    errors[field] = _("Field is required.")
        if errors:
            raise serializers.ValidationError(errors)