Skip to main content

Validation and data pipelines made easy!

Project description

https://travis-ci.org/eflglobal/filters.svg?branch=master https://readthedocs.org/projects/filters/badge/?version=latest

Filters

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.

Examples

Validate a latitude position and round to manageable precision:

(
    f.Required
  | f.Decimal
  | f.Min(Decimal(-90))
  | f.Max(Decimal(90))
  | f.Round(to_nearest='0.000001')
).apply('-12.0431842')

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

f.Datetime(naive=True).apply('2015-04-08T15:11:22-05:00')

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
  | f.FilterMapper(
      {
        'birthday':  f.Date,
        'gender':    f.CaseFold | f.Choice(choices={'m', 'f', 'x'}),

        'utcOffset':
            f.Decimal
          | f.Min(Decimal('-15'))
          | f.Max(Decimal('+15'))
          | f.Round(to_nearest='0.25'),
      },

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

Requirements

Filters is compatible with Python versions 3.6, 3.5 and 2.7.

Installation

Install the latest stable version via pip:

pip install filters

Extensions

The following extensions are available:

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

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

    pip install filters[iso]

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

filters-1.3.0.tar.gz (57.7 kB view details)

Uploaded Source

Built Distributions

filters-1.3.0-py3-none-any.whl (37.0 kB view details)

Uploaded Python 3

filters-1.3.0-py2-none-any.whl (37.0 kB view details)

Uploaded Python 2

File details

Details for the file filters-1.3.0.tar.gz.

File metadata

  • Download URL: filters-1.3.0.tar.gz
  • Upload date:
  • Size: 57.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for filters-1.3.0.tar.gz
Algorithm Hash digest
SHA256 5bcbcd69373e9df619ee677e5e77088a84d1aeb68e8f2ca2d99726998d6410aa
MD5 c5f7427b00594ad7a9cad76fa29d1f9f
BLAKE2b-256 97371324d78c6133ff8091d5d9c5eb301b95aab485bac6cee14e0b451a623ad3

See more details on using hashes here.

File details

Details for the file filters-1.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for filters-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c4e407bc0328375fbf5f5a8207d9e91366e8d02858e94c3e5348df48992ffc10
MD5 dfa791716cf35661d4ad538e1bd8c72c
BLAKE2b-256 ee1c6d356bba459c802647a77befe02253ef4077c72f8711eeece29e90225036

See more details on using hashes here.

File details

Details for the file filters-1.3.0-py2-none-any.whl.

File metadata

File hashes

Hashes for filters-1.3.0-py2-none-any.whl
Algorithm Hash digest
SHA256 55ba243a8074a42f68bc46be8d2f7cf00adf489fb75744155bc5ad21d22ce70b
MD5 1499c7a992b892cc1f400de9903c6dc1
BLAKE2b-256 622421dbc5c4c02c104cbfe5bc567c5629607743c3ebb12e4085b33b3628c92a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page