Skip to main content

Validation and data pipelines made easy!

Project description


The Filters library provides an easy and readable way to create complex data validation and processing pipelines, including:

  • Validating complex JSON structures in API requests or config files.
  • Parsing timestamps and converting to UTC.
  • Converting Unicode strings to NFC, normalizing line endings and removing unprintable characters.
  • Decoding Base64, including URL-safe variants.

And much more!

The output from one filter can be “piped” into the input of another, enabling you to “chain” filters together to quickly and easily create complex data pipelines.


Validate a latitude position and round to manageable precision:

    f.Required |
    f.Decimal |
    f.Min(Decimal(-90)) |
    f.Max(Decimal(90)) |

Parse an incoming value as a datetime, convert to UTC and strip tzinfo:


Convert every value in an iterable (e.g., list) to unicode and strip leading/trailing whitespace. This also applies Unicode normalization, strips unprintable characters and normalizes line endings automatically.

f.FilterRepeater(f.Unicode | f.Strip).apply([
    b'\xe2\x99\xaa ',
    b'\xe2\x94\x8f(\xc2\xb0.\xc2\xb0)\xe2\x94\x9b ',
    b'\xe2\x94\x97(\xc2\xb0.\xc2\xb0)\xe2\x94\x93 ',
    b'\xe2\x99\xaa ',

Parse a JSON string and check that it has correct structure:

    f.JsonDecode |
            'birthday':  f.Date,
            'gender':    f.CaseFold | f.Choice(choices={'m', 'f', 'x'}),

                f.Decimal |
                f.Min(Decimal('-15')) |
                f.Max(Decimal('+15')) |

        allow_extra_keys   = False,
        allow_missing_keys = False,
).apply('{"birthday":"1879-03-14", "gender":"M", "utcOffset":"1"}')


Filters is compatible with the following Python versions:

  • 3.8
  • 3.7
  • 3.6
  • 3.5


Filters is not compatible with Python 2.


Install the latest stable version via pip:

pip install phx-filters


The following extensions are available:

  • Django Filters: Adds filters designed to work with Django applications. To install:

    pip install phx-filters[django]
  • ISO Filters: Adds filters for interpreting standard codes and identifiers. To install:

    pip install phx-filters[iso]


To install multiple extensions, separate them with commas, e.g.:

pip install phx-filters[django,iso]

Running Unit Tests

To run unit tests after installing from source:

python test

This project is also compatible with tox, which will run the unit tests in different virtual environments (one for each supported version of Python).

Install the package with the test-runner extra to set up the necessary dependencies, and then you can run the tests with the tox command:

pip install -e .[test-runner]
tox -p all


Documentation is available on ReadTheDocs.

If you are installing from source (see above), you can also build the documentation locally:

  1. Install extra dependencies (you only have to do this once):

    pip install '.[docs-builder]'
  2. Switch to the docs directory:

    cd docs
  3. Build the documentation:

    make html

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

phx-filters-2.0.2.tar.gz (59.9 kB view hashes)

Uploaded source

Built Distribution

phx_filters-2.0.2-py3-none-any.whl (35.9 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page