flask-inputfilter 0.4.0a1

A library to easily filter and validate input data in Flask applications

flask-inputfilter

The InputFilter class is used to validate and filter input data in Flask applications. It provides a modular way to clean and ensure that incoming data meets expected format and type requirements before being processed.

Thank you for using flask-inputfilter!

If you have any questions or suggestions, please feel free to open an issue on GitHub.

If you don’t want to miss any updates, please star the repository. This will help me to understand how many people are interested in this project.

For information about the usage you can view the documentation.

Test Status:

Version Info:

Compatibility:

Downloads:

Installation

pip install flask-inputfilter

Quickstart

To use the InputFilter class, create a new class that inherits from it and define the fields you want to validate and filter.

There are numerous filters and validators available, but you can also create your own.

Definition

from flask_inputfilter import InputFilter
from flask_inputfilter.Condition import ExactlyOneOfCondition
from flask_inputfilter.Enum import RegexEnum
from flask_inputfilter.Filter import StringTrimFilter, ToIntegerFilter, ToNullFilter
from flask_inputfilter.Validator import IsIntegerValidator, IsStringValidator, RegexValidator

class UpdateZipcodeInputFilter(InputFilter):
    def __init__(self):

        self.add(
            'id',
            required=True,
            filters=[ToIntegerFilter(), ToNullFilter()],
            validators=[
                IsIntegerValidator()
            ]
        )

        self.add(
            'zipcode',
            filters=[StringTrimFilter()],
            validators=[
                RegexValidator(
                    RegexEnum.POSTAL_CODE.value,
                    'The zipcode is not in the correct format.'
                )
            ]
        )

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

        self.addCondition(
            ExactlyOneOfCondition(['zipcode', 'city'])
        )

Usage

To use the InputFilter class, call the validate method on the class instance. After calling validate, the validated data will be available in g.validated_data. If the data is invalid, a 400 response with an error message will be returned.

from flask import Flask, g
from your-path import UpdateZipcodeInputFilter

app = Flask(__name__)

@app.route('/update-zipcode', methods=['POST'])
@UpdateZipcodeInputFilter.validate()
def updateZipcode():
    data = g.validated_data

    # Do something with validated data
    id = data.get('id')
    zipcode = data.get('zipcode')
    city = data.get('city')

See also

For further instructions please view the documentary.

For ideas, suggestions or questions, please open an issue on GitHub.