phx-filters 3.2.1

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 known to be compatible with the following Python versions:

• 3.11

• 3.10

• 3.9

Installation

Install the latest stable version via pip:

pip install phx-filters

Running Unit Tests

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

To run tests in the current virtualenv:

python -m unittest

Documentation

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

Releases

Steps to build releases are based on Packaging Python Projects Tutorial