Condition

Conditions are used to validate the input data based on rules between fields. They ensure that the relationships between multiple fields satisfy specific criteria before further processing.

Overview

Conditions are added using the add_condition method. They evaluate the combined input data, ensuring that inter-field dependencies and relationships (such as equality, ordering, or presence) meet predefined rules.

Example

from flask_inputfilter import InputFilter
from flask_inputfilter.conditions import OneOfCondition
from flask_inputfilter.filters import StringTrimFilter
from flask_inputfilter.validators import IsStringValidator

class TestInputFilter(InputFilter):
    def __init__(self):
        super().__init__()

        self.add(
            'username',
            filters=[StringTrimFilter()],
            validators=[IsStringValidator()]
        )

        self.add(
            'name',
            filters=[StringTrimFilter()],
            validators=[IsStringValidator()]
        )

        self.add_condition(
            OneOfCondition(['id', 'name'])
        )

Available Conditions

Base Condition

Detailed Description